@proteinjs/service 1.0.18 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/index.js +1 -1
- package/dist/generated/index.js.map +1 -1
- package/dist/src/Service.d.ts +3 -1
- package/dist/src/Service.d.ts.map +1 -1
- package/dist/src/Service.js +3 -2
- package/dist/src/Service.js.map +1 -1
- package/dist/src/ServiceClient.d.ts +3 -1
- package/dist/src/ServiceClient.d.ts.map +1 -1
- package/dist/src/ServiceClient.js +31 -17
- package/dist/src/ServiceClient.js.map +1 -1
- package/generated/index.ts +1 -1
- package/package.json +8 -8
- package/src/Service.ts +8 -3
- package/src/ServiceClient.ts +25 -16
package/dist/generated/index.js
CHANGED
|
@@ -21,7 +21,7 @@ require("@proteinjs/server-api");
|
|
|
21
21
|
require("@proteinjs/user-auth");
|
|
22
22
|
require("@proteinjs/util");
|
|
23
23
|
/** Generate Source Graph */
|
|
24
|
-
var sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/service/Service\",\"value\":{\"packageName\":\"@proteinjs/service\",\"name\":\"Service\",\"filePath\":\"/Users/veronica/
|
|
24
|
+
var sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/service/Service\",\"value\":{\"packageName\":\"@proteinjs/service\",\"name\":\"Service\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/service/packages/service/src/Service.ts\",\"qualifiedName\":\"@proteinjs/service/Service\",\"properties\":[{\"name\":\"serviceMetadata\",\"type\":{\"packageName\":\"@proteinjs/service\",\"name\":\"{\\n auth?: {\\n /** If true, the user does not need to be logged in or have any roles to call this service. If blank, defaults to false. */\\n public?: boolean;\\n /** If true, the user does not need to have any roles to call this service, but must be logged in. If blank, defaults to false. */\\n allUsers?: boolean;\\n /** The user must be logged in and have these roles to call this service. If blank, defaults to requiring the 'admin' role. */\\n roles?: string[];\\n /**\\n * Custom auth function. If provided, all other auth properties are ignored.\\n * @param methodName the name of the service method to be executed\\n * @param args the args[] that will be passed into the method\\n * @return true if the user can access the service method\\n */\\n canAccess?: (methodName: string, args: any[]) => boolean;\\n };\\n /** Don't await the service's execution, return a response to the client immediately */\\n doNotAwait?: boolean;\\n }\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/service/{\\n auth?: {\\n /** If true, the user does not need to be logged in or have any roles to call this service. If blank, defaults to false. */\\n public?: boolean;\\n /** If true, the user does not need to have any roles to call this service, but must be logged in. If blank, defaults to false. */\\n allUsers?: boolean;\\n /** The user must be logged in and have these roles to call this service. If blank, defaults to requiring the 'admin' role. */\\n roles?: string[];\\n /**\\n * Custom auth function. If provided, all other auth properties are ignored.\\n * @param methodName the name of the service method to be executed\\n * @param args the args[] that will be passed into the method\\n * @return true if the user can access the service method\\n */\\n canAccess?: (methodName: string, args: any[]) => boolean;\\n };\\n /** Don't await the service's execution, return a response to the client immediately */\\n doNotAwait?: boolean;\\n }\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":true,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"}],\"methods\":[],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/service/ServiceRouter\",\"value\":{\"packageName\":\"@proteinjs/service\",\"name\":\"ServiceRouter\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/service/packages/service/src/ServiceRouter.ts\",\"qualifiedName\":\"@proteinjs/service/ServiceRouter\",\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"properties\":[{\"name\":\"logger\",\"type\":null,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"},{\"name\":\"serviceExecutorMap\",\"type\":{\"packageName\":\"@proteinjs/service\",\"name\":\"{ [path: string]: ServiceExecutor } | undefined\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/service/{ [path: string]: ServiceExecutor } | undefined\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"},{\"name\":\"path\",\"type\":null,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"},{\"name\":\"method\",\"type\":{\"packageName\":\"\",\"name\":\"'post'\",\"filePath\":null,\"qualifiedName\":\"/'post'\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"}],\"methods\":[{\"name\":\"getServiceExecutorMap\",\"returnType\":null,\"isAsync\":false,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\",\"parameters\":[]},{\"name\":\"onRequest\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<any>\",\"filePath\":null,\"qualifiedName\":\"/Promise<any>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"request\",\"type\":{\"packageName\":\"\",\"name\":\"any\",\"filePath\":null,\"qualifiedName\":\"/any\",\"typeParameters\":null,\"directParents\":null}},{\"name\":\"response\",\"type\":{\"packageName\":\"\",\"name\":\"any\",\"filePath\":null,\"qualifiedName\":\"/any\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParentInterfaces\":[{\"packageName\":\"@proteinjs/server-api\",\"name\":\"Route\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/server-api/Route\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"directParentClasses\":[],\"sourceType\":2}},{\"v\":\"@proteinjs/server-api/Route\"}],\"edges\":[{\"v\":\"@proteinjs/service/Service\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/service/ServiceRouter\",\"w\":\"@proteinjs/server-api/Route\",\"value\":\"implements interface\"}]}";
|
|
25
25
|
/** Generate Source Links */
|
|
26
26
|
var ServiceRouter_1 = require("../src/ServiceRouter");
|
|
27
27
|
var sourceLinks = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,iCAA+B;AAC/B,iCAA+B;AAC/B,iCAA+B;AAC/B,gCAA8B;AAC9B,2BAAyB;AAGzB,4BAA4B;AAE5B,IAAM,WAAW,GAAG,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,iCAA+B;AAC/B,iCAA+B;AAC/B,iCAA+B;AAC/B,gCAA8B;AAC9B,2BAAyB;AAGzB,4BAA4B;AAE5B,IAAM,WAAW,GAAG,ooLAAooL,CAAC;AAGzpL,4BAA4B;AAE5B,sDAAqD;AAErD,IAAM,WAAW,GAAG;IACnB,kCAAkC,EAAE,6BAAa;CACjD,CAAC;AAGF,kCAAkC;AAElC,oDAAyD;AACzD,6BAAgB,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAGjD,2CAAyB"}
|
package/dist/src/Service.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { SerializableFunction, NotFunction } from '@proteinjs/serializer';
|
|
2
2
|
import { Loadable } from '@proteinjs/reflection';
|
|
3
|
+
import { Debouncer } from '@proteinjs/util';
|
|
3
4
|
export interface Service extends Loadable {
|
|
4
5
|
serviceMetadata?: {
|
|
5
6
|
auth?: {
|
|
@@ -26,7 +27,8 @@ export interface Service extends Loadable {
|
|
|
26
27
|
* Create a factory that creates an instance of the Service. The Service instance is a
|
|
27
28
|
* ServiceClient wrapped in the interface's api.
|
|
28
29
|
* @param serviceInterfaceQualifiedName the package-qualified name of the service interface (ie. service-package-name/MyService)
|
|
30
|
+
* @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
|
|
29
31
|
* @returns a function that creates a Service
|
|
30
32
|
*/
|
|
31
|
-
export declare const serviceFactory: <T extends Service>(serviceInterfaceQualifiedName: string) => () => T;
|
|
33
|
+
export declare const serviceFactory: <T extends Service>(serviceInterfaceQualifiedName: string, debouncer?: Debouncer) => () => T;
|
|
32
34
|
//# sourceMappingURL=Service.d.ts.map
|
|
@@ -1 +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,
|
|
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,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,YAatB,CAAC"}
|
package/dist/src/Service.js
CHANGED
|
@@ -7,16 +7,17 @@ var ServiceClient_1 = require("./ServiceClient");
|
|
|
7
7
|
* Create a factory that creates an instance of the Service. The Service instance is a
|
|
8
8
|
* ServiceClient wrapped in the interface's api.
|
|
9
9
|
* @param serviceInterfaceQualifiedName the package-qualified name of the service interface (ie. service-package-name/MyService)
|
|
10
|
+
* @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
|
|
10
11
|
* @returns a function that creates a Service
|
|
11
12
|
*/
|
|
12
|
-
var serviceFactory = function (serviceInterfaceQualifiedName) {
|
|
13
|
+
var serviceFactory = function (serviceInterfaceQualifiedName, debouncer) {
|
|
13
14
|
return function () {
|
|
14
15
|
var service = {};
|
|
15
16
|
var serviceInterface = reflection_1.SourceRepository.get().interface(serviceInterfaceQualifiedName);
|
|
16
17
|
for (var _i = 0, _a = serviceInterface.methods; _i < _a.length; _i++) {
|
|
17
18
|
var method = _a[_i];
|
|
18
19
|
var servicePath = "/service/".concat(serviceInterface.qualifiedName, "/").concat(method.name);
|
|
19
|
-
var serviceClient = new ServiceClient_1.ServiceClient(servicePath, method);
|
|
20
|
+
var serviceClient = new ServiceClient_1.ServiceClient(servicePath, method, debouncer);
|
|
20
21
|
service[method.name] = serviceClient.send.bind(serviceClient);
|
|
21
22
|
}
|
|
22
23
|
return service;
|
package/dist/src/Service.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":";;;AACA,oDAAmE;AACnE,iDAAgD;AA0BhD;;;;;;GAMG;AACI,IAAM,cAAc,GAAG,UAC5B,6BAAqC,EACrC,SAAqB;IAErB,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,aAAa,GAAG,IAAI,6BAAa,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;YACxE,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;AAfW,QAAA,cAAc,kBAezB"}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { Method } from '@proteinjs/reflection';
|
|
2
|
+
import { Debouncer } from '@proteinjs/util';
|
|
2
3
|
export declare class ServiceClient {
|
|
3
4
|
private servicePath;
|
|
4
5
|
private serviceMethod;
|
|
6
|
+
private debouncer?;
|
|
5
7
|
private static requestCounter;
|
|
6
8
|
private logger;
|
|
7
|
-
constructor(servicePath: string, serviceMethod: Method);
|
|
9
|
+
constructor(servicePath: string, serviceMethod: Method, debouncer?: Debouncer | undefined);
|
|
8
10
|
send(...args: any[]): Promise<any>;
|
|
9
11
|
private _send;
|
|
10
12
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServiceClient.d.ts","sourceRoot":"","sources":["../../src/ServiceClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"ServiceClient.d.ts","sourceRoot":"","sources":["../../src/ServiceClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C,OAAO,EAAE,SAAS,EAAU,MAAM,iBAAiB,CAAC;AAGpD,qBAAa,aAAa;IAKtB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS,CAAC;IANpB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAK;IAClC,OAAO,CAAC,MAAM,CAAmD;gBAGvD,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,SAAS,CAAC,uBAAW;IAGzB,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;YAyB1B,KAAK;CAsBpB"}
|
|
@@ -41,9 +41,10 @@ var serializer_1 = require("@proteinjs/serializer");
|
|
|
41
41
|
var util_1 = require("@proteinjs/util");
|
|
42
42
|
var isVoidReturnType_1 = require("./isVoidReturnType");
|
|
43
43
|
var ServiceClient = /** @class */ (function () {
|
|
44
|
-
function ServiceClient(servicePath, serviceMethod) {
|
|
44
|
+
function ServiceClient(servicePath, serviceMethod, debouncer) {
|
|
45
45
|
this.servicePath = servicePath;
|
|
46
46
|
this.serviceMethod = serviceMethod;
|
|
47
|
+
this.debouncer = debouncer;
|
|
47
48
|
this.logger = new util_1.Logger(this.constructor.name, 'info', 2000);
|
|
48
49
|
}
|
|
49
50
|
ServiceClient.prototype.send = function () {
|
|
@@ -52,24 +53,37 @@ var ServiceClient = /** @class */ (function () {
|
|
|
52
53
|
args[_i] = arguments[_i];
|
|
53
54
|
}
|
|
54
55
|
return __awaiter(this, void 0, void 0, function () {
|
|
55
|
-
var
|
|
56
|
+
var sendRequest;
|
|
57
|
+
var _this = this;
|
|
56
58
|
return __generator(this, function (_a) {
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
59
|
+
sendRequest = function () { return __awaiter(_this, void 0, void 0, function () {
|
|
60
|
+
var serializedArgs, requestNumber, serializedReturn;
|
|
61
|
+
return __generator(this, function (_a) {
|
|
62
|
+
switch (_a.label) {
|
|
63
|
+
case 0:
|
|
64
|
+
serializedArgs = serializer_1.Serializer.serialize(args);
|
|
65
|
+
requestNumber = ServiceClient.requestCounter;
|
|
66
|
+
ServiceClient.requestCounter++;
|
|
67
|
+
console.groupCollapsed("[#".concat(requestNumber, "] Sending service request: ").concat(this.servicePath, ", args:"));
|
|
68
|
+
console.log(serializedArgs);
|
|
69
|
+
console.groupEnd();
|
|
70
|
+
return [4 /*yield*/, this._send(this.servicePath, serializedArgs)];
|
|
71
|
+
case 1:
|
|
72
|
+
serializedReturn = _a.sent();
|
|
73
|
+
console.groupCollapsed("[#".concat(requestNumber, "] Received service response: ").concat(this.servicePath, ", return:").concat((0, isVoidReturnType_1.isVoidReturnType)(this.serviceMethod) ? ' (void)' : ''));
|
|
74
|
+
console.log(serializedReturn);
|
|
75
|
+
console.groupEnd();
|
|
76
|
+
return [2 /*return*/, serializer_1.Serializer.deserialize(serializedReturn)];
|
|
77
|
+
}
|
|
78
|
+
});
|
|
79
|
+
}); };
|
|
80
|
+
if (this.debouncer) {
|
|
81
|
+
this.debouncer.debounce(sendRequest);
|
|
82
|
+
}
|
|
83
|
+
else {
|
|
84
|
+
return [2 /*return*/, sendRequest()];
|
|
72
85
|
}
|
|
86
|
+
return [2 /*return*/];
|
|
73
87
|
});
|
|
74
88
|
});
|
|
75
89
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ServiceClient.js","sourceRoot":"","sources":["../../src/ServiceClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,oDAAmD;AACnD,
|
|
1
|
+
{"version":3,"file":"ServiceClient.js","sourceRoot":"","sources":["../../src/ServiceClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,oDAAmD;AACnD,wCAAoD;AACpD,uDAAsD;AAEtD;IAIE,uBACU,WAAmB,EACnB,aAAqB,EACrB,SAAqB;QAFrB,gBAAW,GAAX,WAAW,CAAQ;QACnB,kBAAa,GAAb,aAAa,CAAQ;QACrB,cAAS,GAAT,SAAS,CAAY;QALvB,WAAM,GAAG,IAAI,aAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAM9D,CAAC;IAEE,4BAAI,GAAV;QAAW,cAAc;aAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;YAAd,yBAAc;;;;;;gBACjB,WAAW,GAAG;;;;;gCACZ,cAAc,GAAG,uBAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gCAC5C,aAAa,GAAG,aAAa,CAAC,cAAc,CAAC;gCACnD,aAAa,CAAC,cAAc,EAAE,CAAC;gCAC/B,OAAO,CAAC,cAAc,CAAC,YAAK,aAAa,wCAA8B,IAAI,CAAC,WAAW,YAAS,CAAC,CAAC;gCAClG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gCAC5B,OAAO,CAAC,QAAQ,EAAE,CAAC;gCACM,qBAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,EAAA;;gCAArE,gBAAgB,GAAG,SAAkD;gCAC3E,OAAO,CAAC,cAAc,CACpB,YAAK,aAAa,0CAAgC,IAAI,CAAC,WAAW,sBAAY,IAAA,mCAAgB,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAE,CACtI,CAAC;gCACF,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;gCAC9B,OAAO,CAAC,QAAQ,EAAE,CAAC;gCAEnB,sBAAO,uBAAU,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAC;;;qBACjD,CAAC;gBAEF,IAAI,IAAI,CAAC,SAAS,EAAE;oBAClB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;iBACtC;qBAAM;oBACL,sBAAO,WAAW,EAAE,EAAC;iBACtB;;;;KACF;IAEa,6BAAK,GAAnB,UAAoB,WAAmB,EAAE,cAAsB;;;;;;wBACvD,OAAO,GAAG,IAAI,OAAO,CAAC,WAAW,EAAE;4BACvC,MAAM,EAAE,MAAM;4BACd,IAAI,EAAE,cAAc;4BACpB,QAAQ,EAAE,QAAQ;4BAClB,WAAW,EAAE,aAAa;4BAC1B,OAAO,EAAE;gCACP,cAAc,EAAE,kBAAkB;6BACnC;yBACF,CAAC,CAAC;wBACc,qBAAM,KAAK,CAAC,OAAO,CAAC,EAAA;;wBAA/B,QAAQ,GAAG,SAAoB;wBACrC,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;4BAC1B,MAAM,IAAI,KAAK,CAAC,6CAAsC,WAAW,sBAAY,QAAQ,CAAC,UAAU,CAAE,CAAC,CAAC;yBACrG;wBAEY,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;wBAA5B,IAAI,GAAG,SAAqB;wBAClC,IAAI,IAAI,CAAC,KAAK,EAAE;4BACd,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;yBAC7B;wBAED,sBAAO,IAAI,CAAC,gBAAgB,EAAC;;;;KAC9B;IAvDc,4BAAc,GAAG,CAAC,AAAJ,CAAK;IAwDpC,oBAAC;CAAA,AAzDD,IAyDC;AAzDY,sCAAa"}
|
package/generated/index.ts
CHANGED
|
@@ -9,7 +9,7 @@ import '@proteinjs/util';
|
|
|
9
9
|
|
|
10
10
|
/** Generate Source Graph */
|
|
11
11
|
|
|
12
|
-
const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/service/Service\",\"value\":{\"packageName\":\"@proteinjs/service\",\"name\":\"Service\",\"filePath\":\"/Users/veronica/
|
|
12
|
+
const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/service/Service\",\"value\":{\"packageName\":\"@proteinjs/service\",\"name\":\"Service\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/service/packages/service/src/Service.ts\",\"qualifiedName\":\"@proteinjs/service/Service\",\"properties\":[{\"name\":\"serviceMetadata\",\"type\":{\"packageName\":\"@proteinjs/service\",\"name\":\"{\\n auth?: {\\n /** If true, the user does not need to be logged in or have any roles to call this service. If blank, defaults to false. */\\n public?: boolean;\\n /** If true, the user does not need to have any roles to call this service, but must be logged in. If blank, defaults to false. */\\n allUsers?: boolean;\\n /** The user must be logged in and have these roles to call this service. If blank, defaults to requiring the 'admin' role. */\\n roles?: string[];\\n /**\\n * Custom auth function. If provided, all other auth properties are ignored.\\n * @param methodName the name of the service method to be executed\\n * @param args the args[] that will be passed into the method\\n * @return true if the user can access the service method\\n */\\n canAccess?: (methodName: string, args: any[]) => boolean;\\n };\\n /** Don't await the service's execution, return a response to the client immediately */\\n doNotAwait?: boolean;\\n }\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/service/{\\n auth?: {\\n /** If true, the user does not need to be logged in or have any roles to call this service. If blank, defaults to false. */\\n public?: boolean;\\n /** If true, the user does not need to have any roles to call this service, but must be logged in. If blank, defaults to false. */\\n allUsers?: boolean;\\n /** The user must be logged in and have these roles to call this service. If blank, defaults to requiring the 'admin' role. */\\n roles?: string[];\\n /**\\n * Custom auth function. If provided, all other auth properties are ignored.\\n * @param methodName the name of the service method to be executed\\n * @param args the args[] that will be passed into the method\\n * @return true if the user can access the service method\\n */\\n canAccess?: (methodName: string, args: any[]) => boolean;\\n };\\n /** Don't await the service's execution, return a response to the client immediately */\\n doNotAwait?: boolean;\\n }\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":true,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"}],\"methods\":[],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/service/ServiceRouter\",\"value\":{\"packageName\":\"@proteinjs/service\",\"name\":\"ServiceRouter\",\"filePath\":\"/Users/veronica/Repositories/n3xa-meta-repo/packages/proteinjs/packages/service/packages/service/src/ServiceRouter.ts\",\"qualifiedName\":\"@proteinjs/service/ServiceRouter\",\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"properties\":[{\"name\":\"logger\",\"type\":null,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"},{\"name\":\"serviceExecutorMap\",\"type\":{\"packageName\":\"@proteinjs/service\",\"name\":\"{ [path: string]: ServiceExecutor } | undefined\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/service/{ [path: string]: ServiceExecutor } | undefined\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\"},{\"name\":\"path\",\"type\":null,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"},{\"name\":\"method\",\"type\":{\"packageName\":\"\",\"name\":\"'post'\",\"filePath\":null,\"qualifiedName\":\"/'post'\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"}],\"methods\":[{\"name\":\"getServiceExecutorMap\",\"returnType\":null,\"isAsync\":false,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"private\",\"parameters\":[]},{\"name\":\"onRequest\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<any>\",\"filePath\":null,\"qualifiedName\":\"/Promise<any>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":true,\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"request\",\"type\":{\"packageName\":\"\",\"name\":\"any\",\"filePath\":null,\"qualifiedName\":\"/any\",\"typeParameters\":null,\"directParents\":null}},{\"name\":\"response\",\"type\":{\"packageName\":\"\",\"name\":\"any\",\"filePath\":null,\"qualifiedName\":\"/any\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParentInterfaces\":[{\"packageName\":\"@proteinjs/server-api\",\"name\":\"Route\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/server-api/Route\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"directParentClasses\":[],\"sourceType\":2}},{\"v\":\"@proteinjs/server-api/Route\"}],\"edges\":[{\"v\":\"@proteinjs/service/Service\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/service/ServiceRouter\",\"w\":\"@proteinjs/server-api/Route\",\"value\":\"implements interface\"}]}";
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
/** Generate Source Links */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@proteinjs/service",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.19",
|
|
4
4
|
"description": "Service api",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -21,14 +21,14 @@
|
|
|
21
21
|
"watch": "reflection-watch"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@proteinjs/reflection": "1.1.
|
|
25
|
-
"@proteinjs/serializer": "1.0.
|
|
26
|
-
"@proteinjs/server-api": "1.3.
|
|
27
|
-
"@proteinjs/user-auth": "1.0.
|
|
28
|
-
"@proteinjs/util": "1.
|
|
24
|
+
"@proteinjs/reflection": "1.1.6",
|
|
25
|
+
"@proteinjs/serializer": "1.0.11",
|
|
26
|
+
"@proteinjs/server-api": "1.3.1",
|
|
27
|
+
"@proteinjs/user-auth": "1.0.11",
|
|
28
|
+
"@proteinjs/util": "1.2.0"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
|
-
"@proteinjs/reflection-build": "1.0.
|
|
31
|
+
"@proteinjs/reflection-build": "1.0.20",
|
|
32
32
|
"@types/jest": "29.5.5",
|
|
33
33
|
"@types/node": "14.0.27",
|
|
34
34
|
"@typescript-eslint/eslint-plugin": "7.8.0",
|
|
@@ -42,4 +42,4 @@
|
|
|
42
42
|
},
|
|
43
43
|
"main": "./dist/generated/index.js",
|
|
44
44
|
"types": "./dist/generated/index.d.ts"
|
|
45
|
-
}
|
|
45
|
+
}
|
package/src/Service.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { SerializableFunction, NotFunction } from '@proteinjs/serializer';
|
|
2
|
-
import { Loadable, SourceRepository
|
|
2
|
+
import { Loadable, SourceRepository } from '@proteinjs/reflection';
|
|
3
3
|
import { ServiceClient } from './ServiceClient';
|
|
4
|
+
import { Debouncer } from '@proteinjs/util';
|
|
4
5
|
|
|
5
6
|
export interface Service extends Loadable {
|
|
6
7
|
serviceMetadata?: {
|
|
@@ -29,15 +30,19 @@ export interface Service extends Loadable {
|
|
|
29
30
|
* Create a factory that creates an instance of the Service. The Service instance is a
|
|
30
31
|
* ServiceClient wrapped in the interface's api.
|
|
31
32
|
* @param serviceInterfaceQualifiedName the package-qualified name of the service interface (ie. service-package-name/MyService)
|
|
33
|
+
* @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
|
|
32
34
|
* @returns a function that creates a Service
|
|
33
35
|
*/
|
|
34
|
-
export const serviceFactory = <T extends Service>(
|
|
36
|
+
export const serviceFactory = <T extends Service>(
|
|
37
|
+
serviceInterfaceQualifiedName: string,
|
|
38
|
+
debouncer?: Debouncer
|
|
39
|
+
): (() => T) => {
|
|
35
40
|
return () => {
|
|
36
41
|
const service: any = {};
|
|
37
42
|
const serviceInterface = SourceRepository.get().interface(serviceInterfaceQualifiedName);
|
|
38
43
|
for (const method of serviceInterface.methods) {
|
|
39
44
|
const servicePath = `/service/${serviceInterface.qualifiedName}/${method.name}`;
|
|
40
|
-
const serviceClient = new ServiceClient(servicePath, method);
|
|
45
|
+
const serviceClient = new ServiceClient(servicePath, method, debouncer);
|
|
41
46
|
service[method.name] = serviceClient.send.bind(serviceClient);
|
|
42
47
|
}
|
|
43
48
|
|
package/src/ServiceClient.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Method } from '@proteinjs/reflection';
|
|
2
2
|
import { Serializer } from '@proteinjs/serializer';
|
|
3
|
-
import { Logger } from '@proteinjs/util';
|
|
3
|
+
import { Debouncer, Logger } from '@proteinjs/util';
|
|
4
4
|
import { isVoidReturnType } from './isVoidReturnType';
|
|
5
5
|
|
|
6
6
|
export class ServiceClient {
|
|
@@ -9,24 +9,33 @@ export class ServiceClient {
|
|
|
9
9
|
|
|
10
10
|
constructor(
|
|
11
11
|
private servicePath: string,
|
|
12
|
-
private serviceMethod: Method
|
|
12
|
+
private serviceMethod: Method,
|
|
13
|
+
private debouncer?: Debouncer
|
|
13
14
|
) {}
|
|
14
15
|
|
|
15
16
|
async send(...args: any[]): Promise<any> {
|
|
16
|
-
const
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
17
|
+
const sendRequest = async () => {
|
|
18
|
+
const serializedArgs = Serializer.serialize(args);
|
|
19
|
+
const requestNumber = ServiceClient.requestCounter;
|
|
20
|
+
ServiceClient.requestCounter++;
|
|
21
|
+
console.groupCollapsed(`[#${requestNumber}] Sending service request: ${this.servicePath}, args:`);
|
|
22
|
+
console.log(serializedArgs);
|
|
23
|
+
console.groupEnd();
|
|
24
|
+
const serializedReturn = await this._send(this.servicePath, serializedArgs);
|
|
25
|
+
console.groupCollapsed(
|
|
26
|
+
`[#${requestNumber}] Received service response: ${this.servicePath}, return:${isVoidReturnType(this.serviceMethod) ? ' (void)' : ''}`
|
|
27
|
+
);
|
|
28
|
+
console.log(serializedReturn);
|
|
29
|
+
console.groupEnd();
|
|
30
|
+
|
|
31
|
+
return Serializer.deserialize(serializedReturn);
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
if (this.debouncer) {
|
|
35
|
+
this.debouncer.debounce(sendRequest);
|
|
36
|
+
} else {
|
|
37
|
+
return sendRequest();
|
|
38
|
+
}
|
|
30
39
|
}
|
|
31
40
|
|
|
32
41
|
private async _send(absoluteUrl: string, serializedArgs: string) {
|