@conduitplatform/grpc-sdk 0.16.0-alpha.2 → 0.16.0-alpha.21

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.
Files changed (249) hide show
  1. package/README.mdx +1 -7
  2. package/dist/classes/ConduitAuthorizedResource.js +5 -6
  3. package/dist/classes/ConduitAuthorizedResource.js.map +1 -1
  4. package/dist/classes/ConduitModule.d.ts +9 -6
  5. package/dist/classes/ConduitModule.js +68 -141
  6. package/dist/classes/ConduitModule.js.map +1 -1
  7. package/dist/classes/ConduitSchema.js +3 -4
  8. package/dist/classes/ConduitSchema.js.map +1 -1
  9. package/dist/classes/Error.js +17 -40
  10. package/dist/classes/Error.js.map +1 -1
  11. package/dist/classes/HealthCheck.js +30 -71
  12. package/dist/classes/HealthCheck.js.map +1 -1
  13. package/dist/classes/index.d.ts +2 -6
  14. package/dist/classes/index.js +2 -6
  15. package/dist/classes/index.js.map +1 -1
  16. package/dist/index.d.ts +34 -31
  17. package/dist/index.js +331 -499
  18. package/dist/index.js.map +1 -1
  19. package/dist/interceptors/grpcSignedToken.d.ts +1 -1
  20. package/dist/interceptors/grpcSignedToken.js +7 -79
  21. package/dist/interceptors/grpcSignedToken.js.map +1 -1
  22. package/dist/interceptors/moduleName.d.ts +1 -1
  23. package/dist/interceptors/moduleName.js +7 -79
  24. package/dist/interceptors/moduleName.js.map +1 -1
  25. package/dist/interfaces/ConduitMiddleware.js.map +1 -0
  26. package/dist/{routing/interfaces → interfaces}/ConduitRoute.d.ts +2 -3
  27. package/dist/interfaces/ConduitRoute.js.map +1 -0
  28. package/dist/{routing → interfaces}/ConduitRouteReturn.d.ts +3 -3
  29. package/dist/{routing → interfaces}/ConduitRouteReturn.js +9 -18
  30. package/dist/interfaces/ConduitRouteReturn.js.map +1 -0
  31. package/dist/interfaces/ConduitSchemaExtension.d.ts +1 -1
  32. package/dist/interfaces/GrpcCallback.d.ts +1 -1
  33. package/dist/{utilities/Logger.d.ts → interfaces/IConduitLogger.d.ts} +4 -7
  34. package/dist/interfaces/{ConduitService.js → IConduitLogger.js} +1 -1
  35. package/dist/interfaces/IConduitLogger.js.map +1 -0
  36. package/dist/{metrics/index.d.ts → interfaces/IConduitMetrics.d.ts} +5 -11
  37. package/dist/interfaces/IConduitMetrics.js +3 -0
  38. package/dist/interfaces/IConduitMetrics.js.map +1 -0
  39. package/dist/interfaces/Indexable.d.ts +7 -8
  40. package/dist/interfaces/Model.d.ts +66 -13
  41. package/dist/interfaces/Model.js.map +1 -1
  42. package/dist/interfaces/Params.d.ts +3 -3
  43. package/dist/interfaces/ProxyRoute.js.map +1 -0
  44. package/dist/interfaces/RawQuery.d.ts +2 -2
  45. package/dist/interfaces/Route.d.ts +64 -0
  46. package/dist/interfaces/Route.js +12 -0
  47. package/dist/interfaces/Route.js.map +1 -0
  48. package/dist/{routing/interfaces → interfaces}/Socket.d.ts +4 -5
  49. package/dist/interfaces/Socket.js.map +1 -0
  50. package/dist/interfaces/UntypedArray.d.ts +1 -1
  51. package/dist/interfaces/index.d.ts +9 -2
  52. package/dist/interfaces/index.js +9 -2
  53. package/dist/interfaces/index.js.map +1 -1
  54. package/dist/{routing/interfaces → interfaces}/types.d.ts +11 -9
  55. package/dist/{routing/interfaces → interfaces}/types.js.map +1 -1
  56. package/dist/module.proto +72 -0
  57. package/dist/modules/admin/index.d.ts +5 -5
  58. package/dist/modules/admin/index.js +18 -37
  59. package/dist/modules/admin/index.js.map +1 -1
  60. package/dist/modules/authentication/index.d.ts +5 -2
  61. package/dist/modules/authentication/index.js +30 -40
  62. package/dist/modules/authentication/index.js.map +1 -1
  63. package/dist/modules/authorization/index.d.ts +6 -2
  64. package/dist/modules/authorization/index.js +38 -47
  65. package/dist/modules/authorization/index.js.map +1 -1
  66. package/dist/modules/chat/index.js +16 -34
  67. package/dist/modules/chat/index.js.map +1 -1
  68. package/dist/modules/config/index.d.ts +14 -5
  69. package/dist/modules/config/index.js +85 -177
  70. package/dist/modules/config/index.js.map +1 -1
  71. package/dist/modules/core/index.js +8 -26
  72. package/dist/modules/core/index.js.map +1 -1
  73. package/dist/modules/database/index.d.ts +24 -14
  74. package/dist/modules/database/index.js +193 -134
  75. package/dist/modules/database/index.js.map +1 -1
  76. package/dist/modules/email/index.js +15 -33
  77. package/dist/modules/email/index.js.map +1 -1
  78. package/dist/modules/index.d.ts +0 -2
  79. package/dist/modules/index.js +0 -2
  80. package/dist/modules/index.js.map +1 -1
  81. package/dist/modules/pushNotifications/index.js +38 -56
  82. package/dist/modules/pushNotifications/index.js.map +1 -1
  83. package/dist/modules/router/index.d.ts +5 -5
  84. package/dist/modules/router/index.js +20 -39
  85. package/dist/modules/router/index.js.map +1 -1
  86. package/dist/modules/sms/index.js +17 -35
  87. package/dist/modules/sms/index.js.map +1 -1
  88. package/dist/modules/storage/index.d.ts +8 -4
  89. package/dist/modules/storage/index.js +66 -37
  90. package/dist/modules/storage/index.js.map +1 -1
  91. package/dist/protoUtils/authentication.d.ts +127 -46
  92. package/dist/protoUtils/authentication.js +481 -220
  93. package/dist/protoUtils/authentication.js.map +1 -1
  94. package/dist/protoUtils/authorization.d.ts +147 -82
  95. package/dist/protoUtils/authorization.js +684 -512
  96. package/dist/protoUtils/authorization.js.map +1 -1
  97. package/dist/protoUtils/chat.d.ts +7 -61
  98. package/dist/protoUtils/chat.js +130 -313
  99. package/dist/protoUtils/chat.js.map +1 -1
  100. package/dist/protoUtils/core.d.ts +88 -107
  101. package/dist/protoUtils/core.js +699 -733
  102. package/dist/protoUtils/core.js.map +1 -1
  103. package/dist/protoUtils/database.d.ts +195 -15
  104. package/dist/protoUtils/database.js +1077 -666
  105. package/dist/protoUtils/database.js.map +1 -1
  106. package/dist/protoUtils/email.d.ts +3 -48
  107. package/dist/protoUtils/email.js +145 -284
  108. package/dist/protoUtils/email.js.map +1 -1
  109. package/dist/protoUtils/google/protobuf/empty.d.ts +27 -0
  110. package/dist/protoUtils/google/protobuf/empty.js +46 -0
  111. package/dist/protoUtils/google/protobuf/empty.js.map +1 -0
  112. package/dist/protoUtils/grpc_health_check.d.ts +3 -4
  113. package/dist/protoUtils/grpc_health_check.js +37 -36
  114. package/dist/protoUtils/grpc_health_check.js.map +1 -1
  115. package/dist/protoUtils/index.d.ts +12 -0
  116. package/dist/{routing/interfaces → protoUtils}/index.js +12 -6
  117. package/dist/protoUtils/index.js.map +1 -0
  118. package/dist/protoUtils/module.d.ts +251 -0
  119. package/dist/protoUtils/module.js +874 -0
  120. package/dist/protoUtils/module.js.map +1 -0
  121. package/dist/protoUtils/push-notifications.d.ts +7 -50
  122. package/dist/protoUtils/push-notifications.js +269 -356
  123. package/dist/protoUtils/push-notifications.js.map +1 -1
  124. package/dist/protoUtils/router.d.ts +45 -111
  125. package/dist/protoUtils/router.js +357 -575
  126. package/dist/protoUtils/router.js.map +1 -1
  127. package/dist/protoUtils/sms.d.ts +3 -48
  128. package/dist/protoUtils/sms.js +120 -219
  129. package/dist/protoUtils/sms.js.map +1 -1
  130. package/dist/protoUtils/storage.d.ts +144 -62
  131. package/dist/protoUtils/storage.js +782 -282
  132. package/dist/protoUtils/storage.js.map +1 -1
  133. package/dist/types/db.d.ts +11 -11
  134. package/dist/types/index.d.ts +3 -10
  135. package/dist/types/index.js +21 -24
  136. package/dist/types/index.js.map +1 -1
  137. package/dist/utilities/EventBus.d.ts +3 -1
  138. package/dist/utilities/EventBus.js +38 -17
  139. package/dist/utilities/EventBus.js.map +1 -1
  140. package/dist/utilities/RedisManager.js +11 -21
  141. package/dist/utilities/RedisManager.js.map +1 -1
  142. package/dist/utilities/StateManager.js +13 -14
  143. package/dist/utilities/StateManager.js.map +1 -1
  144. package/dist/utilities/env.js +4 -4
  145. package/dist/utilities/env.js.map +1 -1
  146. package/dist/utilities/index.d.ts +3 -2
  147. package/dist/utilities/index.js +3 -2
  148. package/dist/utilities/index.js.map +1 -1
  149. package/dist/utilities/sleep.js +1 -1
  150. package/dist/utilities/sleep.js.map +1 -1
  151. package/package.json +24 -25
  152. package/dist/classes/ConduitActiveSchema.d.ts +0 -19
  153. package/dist/classes/ConduitActiveSchema.js +0 -57
  154. package/dist/classes/ConduitActiveSchema.js.map +0 -1
  155. package/dist/classes/ConduitServiceModule.d.ts +0 -26
  156. package/dist/classes/ConduitServiceModule.js +0 -166
  157. package/dist/classes/ConduitServiceModule.js.map +0 -1
  158. package/dist/classes/ConfigController.d.ts +0 -7
  159. package/dist/classes/ConfigController.js +0 -27
  160. package/dist/classes/ConfigController.js.map +0 -1
  161. package/dist/classes/GrpcServer.d.ts +0 -22
  162. package/dist/classes/GrpcServer.js +0 -207
  163. package/dist/classes/GrpcServer.js.map +0 -1
  164. package/dist/classes/ManagedModule.d.ts +0 -74
  165. package/dist/classes/ManagedModule.js +0 -333
  166. package/dist/classes/ManagedModule.js.map +0 -1
  167. package/dist/classes/ModuleManager.d.ts +0 -11
  168. package/dist/classes/ModuleManager.js +0 -204
  169. package/dist/classes/ModuleManager.js.map +0 -1
  170. package/dist/helpers/GrpcHelper.d.ts +0 -8
  171. package/dist/helpers/GrpcHelper.js +0 -43
  172. package/dist/helpers/GrpcHelper.js.map +0 -1
  173. package/dist/helpers/TypeHelpers.d.ts +0 -44
  174. package/dist/helpers/TypeHelpers.js +0 -144
  175. package/dist/helpers/TypeHelpers.js.map +0 -1
  176. package/dist/helpers/index.d.ts +0 -3
  177. package/dist/helpers/index.js +0 -20
  178. package/dist/helpers/index.js.map +0 -1
  179. package/dist/helpers/wrapGrpcFunctions.d.ts +0 -5
  180. package/dist/helpers/wrapGrpcFunctions.js +0 -56
  181. package/dist/helpers/wrapGrpcFunctions.js.map +0 -1
  182. package/dist/interfaces/ConduitService.d.ts +0 -8
  183. package/dist/interfaces/ConduitService.js.map +0 -1
  184. package/dist/metrics/MetricsServer.d.ts +0 -9
  185. package/dist/metrics/MetricsServer.js +0 -94
  186. package/dist/metrics/MetricsServer.js.map +0 -1
  187. package/dist/metrics/clientMiddleware.d.ts +0 -2
  188. package/dist/metrics/clientMiddleware.js +0 -265
  189. package/dist/metrics/clientMiddleware.js.map +0 -1
  190. package/dist/metrics/config/defaults.d.ts +0 -91
  191. package/dist/metrics/config/defaults.js +0 -93
  192. package/dist/metrics/config/defaults.js.map +0 -1
  193. package/dist/metrics/index.js +0 -152
  194. package/dist/metrics/index.js.map +0 -1
  195. package/dist/modules/forms/index.d.ts +0 -6
  196. package/dist/modules/forms/index.js +0 -32
  197. package/dist/modules/forms/index.js.map +0 -1
  198. package/dist/modules/functions/index.d.ts +0 -6
  199. package/dist/modules/functions/index.js +0 -32
  200. package/dist/modules/functions/index.js.map +0 -1
  201. package/dist/protoUtils/forms.d.ts +0 -58
  202. package/dist/protoUtils/forms.js +0 -127
  203. package/dist/protoUtils/forms.js.map +0 -1
  204. package/dist/protoUtils/functions.d.ts +0 -58
  205. package/dist/protoUtils/functions.js +0 -127
  206. package/dist/protoUtils/functions.js.map +0 -1
  207. package/dist/routing/ConduitRouteReturn.js.map +0 -1
  208. package/dist/routing/ProxyRouteBuilder.d.ts +0 -21
  209. package/dist/routing/ProxyRouteBuilder.js +0 -81
  210. package/dist/routing/ProxyRouteBuilder.js.map +0 -1
  211. package/dist/routing/RouteBuilder.d.ts +0 -24
  212. package/dist/routing/RouteBuilder.js +0 -107
  213. package/dist/routing/RouteBuilder.js.map +0 -1
  214. package/dist/routing/RoutingManager.d.ts +0 -33
  215. package/dist/routing/RoutingManager.js +0 -201
  216. package/dist/routing/RoutingManager.js.map +0 -1
  217. package/dist/routing/RoutingUtilities.d.ts +0 -7
  218. package/dist/routing/RoutingUtilities.js +0 -13
  219. package/dist/routing/RoutingUtilities.js.map +0 -1
  220. package/dist/routing/index.d.ts +0 -7
  221. package/dist/routing/index.js +0 -24
  222. package/dist/routing/index.js.map +0 -1
  223. package/dist/routing/interfaces/ConduitMiddleware.js.map +0 -1
  224. package/dist/routing/interfaces/ConduitRoute.js.map +0 -1
  225. package/dist/routing/interfaces/ProxyRoute.js.map +0 -1
  226. package/dist/routing/interfaces/Route.d.ts +0 -52
  227. package/dist/routing/interfaces/Route.js +0 -21
  228. package/dist/routing/interfaces/Route.js.map +0 -1
  229. package/dist/routing/interfaces/Socket.js.map +0 -1
  230. package/dist/routing/interfaces/index.d.ts +0 -6
  231. package/dist/routing/interfaces/index.js.map +0 -1
  232. package/dist/routing/wrapRouterFunctions.d.ts +0 -8
  233. package/dist/routing/wrapRouterFunctions.js +0 -132
  234. package/dist/routing/wrapRouterFunctions.js.map +0 -1
  235. package/dist/utilities/Logger.js +0 -255
  236. package/dist/utilities/Logger.js.map +0 -1
  237. package/dist/utilities/linearBackoffTimeout.d.ts +0 -10
  238. package/dist/utilities/linearBackoffTimeout.js +0 -119
  239. package/dist/utilities/linearBackoffTimeout.js.map +0 -1
  240. package/dist/utilities/merge.d.ts +0 -1
  241. package/dist/utilities/merge.js +0 -15
  242. package/dist/utilities/merge.js.map +0 -1
  243. /package/dist/{routing/interfaces → interfaces}/ConduitMiddleware.d.ts +0 -0
  244. /package/dist/{routing/interfaces → interfaces}/ConduitMiddleware.js +0 -0
  245. /package/dist/{routing/interfaces → interfaces}/ConduitRoute.js +0 -0
  246. /package/dist/{routing/interfaces → interfaces}/ProxyRoute.d.ts +0 -0
  247. /package/dist/{routing/interfaces → interfaces}/ProxyRoute.js +0 -0
  248. /package/dist/{routing/interfaces → interfaces}/Socket.js +0 -0
  249. /package/dist/{routing/interfaces → interfaces}/types.js +0 -0
package/dist/index.d.ts CHANGED
@@ -1,40 +1,48 @@
1
- import { Admin, Authentication, Authorization, Chat, Config, Core, DatabaseProvider, Email, Forms, Functions, PushNotifications, Router, SMS, Storage } from './modules';
2
- import { EventBus } from './utilities/EventBus';
3
- import { RedisManager } from './utilities/RedisManager';
4
- import { StateManager } from './utilities/StateManager';
1
+ import { Admin, Authentication, Authorization, Chat, Config, Core, DatabaseProvider, Email, PushNotifications, Router, SMS, Storage } from './modules';
2
+ import { EventBus, RedisManager, StateManager } from './utilities';
5
3
  import { CompatServiceDefinition } from 'nice-grpc/lib/service-definitions';
6
- import { ConduitModule } from './classes/ConduitModule';
4
+ import { ConduitModule } from './classes';
7
5
  import { Client } from 'nice-grpc';
8
- import { HealthDefinition } from './protoUtils/grpc_health_check';
6
+ import { ConduitModuleDefinition, HealthDefinition } from './protoUtils';
9
7
  import { HealthCheckStatus } from './types';
10
- import { ConduitLogger } from './utilities/Logger';
11
- import { ConduitMetrics } from './metrics';
12
8
  import { ClusterOptions, RedisOptions } from 'ioredis';
9
+ import { IConduitLogger, IConduitMetrics } from './interfaces';
13
10
  export default class ConduitGrpcSdk {
11
+ private static middleware;
12
+ readonly name: string;
13
+ readonly instance: string;
14
14
  private readonly serverUrl;
15
15
  private readonly _watchModules;
16
16
  private readonly _core?;
17
17
  private readonly _config?;
18
18
  private readonly _admin?;
19
- private _redisManager;
20
- private _redisDetails?;
21
19
  private readonly _modules;
22
20
  private readonly _availableModules;
23
21
  private _dynamicModules;
24
22
  private _eventBus?;
25
23
  private _stateManager?;
26
24
  private lastSearch;
27
- private readonly name;
28
- private readonly instance;
29
25
  private readonly urlRemap?;
30
26
  private readonly _serviceHealthStatusGetter;
31
27
  private readonly _grpcToken?;
32
28
  private _initialized;
33
- static Metrics?: ConduitMetrics;
34
- static readonly Logger: ConduitLogger;
35
- constructor(serverUrl: string, serviceHealthStatusGetter?: () => HealthCheckStatus, name?: string, watchModules?: boolean);
36
- initialize(): Promise<void>;
37
- private _initialize;
29
+ constructor(serverUrl: string, name?: string, watchModules?: boolean, logger?: IConduitLogger, serviceHealthStatusGetter?: () => HealthCheckStatus);
30
+ private static _Logger;
31
+ static get Logger(): IConduitLogger | Console;
32
+ private static _Metrics;
33
+ static get Metrics(): IConduitMetrics | undefined;
34
+ static set Metrics(metrics: IConduitMetrics | undefined);
35
+ static get interceptors(): any[];
36
+ private _redisManager;
37
+ get redisManager(): RedisManager;
38
+ private _redisDetails?;
39
+ get redisDetails(): RedisOptions | {
40
+ nodes: {
41
+ host: string;
42
+ port: number;
43
+ }[];
44
+ options: ClusterOptions;
45
+ };
38
46
  get bus(): EventBus | null;
39
47
  get state(): StateManager | null;
40
48
  get core(): Core;
@@ -44,39 +52,34 @@ export default class ConduitGrpcSdk {
44
52
  get database(): DatabaseProvider | null;
45
53
  get databaseProvider(): DatabaseProvider | null;
46
54
  get storage(): Storage | null;
47
- get forms(): Forms | null;
48
55
  get emailProvider(): Email | null;
49
56
  get pushNotifications(): PushNotifications | null;
50
57
  get authentication(): Authentication | null;
51
58
  get authorization(): Authorization | null;
52
59
  get sms(): SMS | null;
53
60
  get chat(): Chat | null;
54
- get functions(): Functions | null;
55
- get redisDetails(): RedisOptions | {
56
- nodes: {
57
- host: string;
58
- port: number;
59
- }[];
60
- options: ClusterOptions;
61
- };
61
+ get grpcToken(): string | undefined;
62
+ addMiddleware(middleware: any): void;
63
+ initialize(): Promise<void>;
62
64
  watchModules(): void;
63
65
  monitorModule(moduleName: string, callback: (serving: boolean) => void, wait?: boolean): void;
64
66
  unmonitorModule(moduleName: string): void;
65
67
  initializeEventBus(): Promise<EventBus>;
66
- get redisManager(): RedisManager;
67
68
  /**
68
69
  * Gets all the registered modules from the config and creates clients for them.
69
70
  * This will only work on known modules, since the primary usage for the sdk is internal
70
71
  */
71
72
  initializeModules(): Promise<string | void>;
73
+ updateModuleHealth(moduleName: string, serving: boolean): void;
72
74
  createModuleClient(moduleName: string, moduleUrl: string): void;
73
75
  isModuleUp(moduleName: string, moduleUrl: string, service?: string): Promise<any>;
74
76
  moduleClient(name: string, type: CompatServiceDefinition): void;
75
77
  getModule<T extends CompatServiceDefinition>(name: string): ConduitModule<T> | undefined;
76
78
  getServiceClient<T extends CompatServiceDefinition>(name: string): Client<T> | undefined;
79
+ getModuleClient(name: string): Client<ConduitModuleDefinition> | undefined;
77
80
  getHealthClient<T extends CompatServiceDefinition>(name: string): Client<typeof HealthDefinition> | undefined;
78
81
  isAvailable(moduleName: string): boolean;
79
- waitForExistence(moduleName: string): Promise<boolean>;
82
+ waitForExistence(moduleName: string, onlyIfServing?: boolean): Promise<unknown>;
80
83
  onceModuleUp(moduleName: string, callback: () => void): void;
81
84
  onceModuleDown(moduleName: string, callback: () => void): void;
82
85
  /**
@@ -84,13 +87,13 @@ export default class ConduitGrpcSdk {
84
87
  * @param force If true will check for new modules no matter the interval
85
88
  */
86
89
  refreshModules(force?: boolean): Promise<string | void>;
87
- get grpcToken(): string | undefined;
90
+ private _initialize;
88
91
  }
89
92
  export * from './interfaces';
90
93
  export * from './classes';
91
94
  export * from './modules';
92
- export * from './helpers';
93
95
  export * from './constants';
94
- export * from './routing';
95
96
  export * from './types';
96
97
  export * from './utilities';
98
+ export * from './protoUtils';
99
+ export * from '@grpc/grpc-js';