@open-core/framework 1.0.1-beta.1

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 (275) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +350 -0
  3. package/dist/client/client-bootstrap.d.ts +1 -0
  4. package/dist/client/client-bootstrap.js +53 -0
  5. package/dist/client/client-container.d.ts +2 -0
  6. package/dist/client/client-container.js +6 -0
  7. package/dist/client/client-core.d.ts +18 -0
  8. package/dist/client/client-core.js +52 -0
  9. package/dist/client/decorators/controller.d.ts +3 -0
  10. package/dist/client/decorators/controller.js +14 -0
  11. package/dist/client/decorators/export.d.ts +7 -0
  12. package/dist/client/decorators/export.js +15 -0
  13. package/dist/client/decorators/gameEvent.d.ts +47 -0
  14. package/dist/client/decorators/gameEvent.js +54 -0
  15. package/dist/client/decorators/index.d.ts +10 -0
  16. package/dist/client/decorators/index.js +26 -0
  17. package/dist/client/decorators/interval.d.ts +7 -0
  18. package/dist/client/decorators/interval.js +15 -0
  19. package/dist/client/decorators/key.d.ts +2 -0
  20. package/dist/client/decorators/key.js +10 -0
  21. package/dist/client/decorators/localEvent.d.ts +7 -0
  22. package/dist/client/decorators/localEvent.js +15 -0
  23. package/dist/client/decorators/nui.d.ts +1 -0
  24. package/dist/client/decorators/nui.js +9 -0
  25. package/dist/client/decorators/onNet.d.ts +1 -0
  26. package/dist/client/decorators/onNet.js +9 -0
  27. package/dist/client/decorators/resourceLifecycle.d.ts +11 -0
  28. package/dist/client/decorators/resourceLifecycle.js +24 -0
  29. package/dist/client/decorators/tick.d.ts +1 -0
  30. package/dist/client/decorators/tick.js +9 -0
  31. package/dist/client/index.d.ts +6 -0
  32. package/dist/client/index.js +22 -0
  33. package/dist/client/loaders/exports.loader.d.ts +1 -0
  34. package/dist/client/loaders/exports.loader.js +13 -0
  35. package/dist/client/player/player.d.ts +262 -0
  36. package/dist/client/player/player.js +480 -0
  37. package/dist/client/player/player.loader.d.ts +1 -0
  38. package/dist/client/player/player.loader.js +22 -0
  39. package/dist/client/services/core/index.d.ts +1 -0
  40. package/dist/client/services/core/index.js +17 -0
  41. package/dist/client/services/core/spawn.service.d.ts +20 -0
  42. package/dist/client/services/core/spawn.service.js +143 -0
  43. package/dist/client/services/index.d.ts +4 -0
  44. package/dist/client/services/index.js +24 -0
  45. package/dist/client/services/streaming/index.d.ts +1 -0
  46. package/dist/client/services/streaming/index.js +17 -0
  47. package/dist/client/services/streaming/streaming.service.d.ts +165 -0
  48. package/dist/client/services/streaming/streaming.service.js +341 -0
  49. package/dist/client/services/ui/index.d.ts +3 -0
  50. package/dist/client/services/ui/index.js +19 -0
  51. package/dist/client/services/ui/notification.service.d.ts +76 -0
  52. package/dist/client/services/ui/notification.service.js +111 -0
  53. package/dist/client/services/ui/progress.service.d.ts +82 -0
  54. package/dist/client/services/ui/progress.service.js +210 -0
  55. package/dist/client/services/ui/textui.service.d.ts +82 -0
  56. package/dist/client/services/ui/textui.service.js +156 -0
  57. package/dist/client/services/world/blip.service.d.ts +112 -0
  58. package/dist/client/services/world/blip.service.js +215 -0
  59. package/dist/client/services/world/index.d.ts +4 -0
  60. package/dist/client/services/world/index.js +20 -0
  61. package/dist/client/services/world/marker.service.d.ts +94 -0
  62. package/dist/client/services/world/marker.service.js +153 -0
  63. package/dist/client/services/world/ped.service.d.ts +182 -0
  64. package/dist/client/services/world/ped.service.js +302 -0
  65. package/dist/client/services/world/vehicle.service.d.ts +168 -0
  66. package/dist/client/services/world/vehicle.service.js +296 -0
  67. package/dist/client/system/metadata-client.keys.d.ts +13 -0
  68. package/dist/client/system/metadata-client.keys.js +16 -0
  69. package/dist/client/system/processors/export.processor.d.ts +7 -0
  70. package/dist/client/system/processors/export.processor.js +39 -0
  71. package/dist/client/system/processors/gameEvent.processor.d.ts +10 -0
  72. package/dist/client/system/processors/gameEvent.processor.js +58 -0
  73. package/dist/client/system/processors/interval.processor.d.ts +7 -0
  74. package/dist/client/system/processors/interval.processor.js +43 -0
  75. package/dist/client/system/processors/key.processor.d.ts +8 -0
  76. package/dist/client/system/processors/key.processor.js +27 -0
  77. package/dist/client/system/processors/localEvent.processor.d.ts +7 -0
  78. package/dist/client/system/processors/localEvent.processor.js +38 -0
  79. package/dist/client/system/processors/netEvent.processor.d.ts +7 -0
  80. package/dist/client/system/processors/netEvent.processor.js +38 -0
  81. package/dist/client/system/processors/nui.processor.d.ts +7 -0
  82. package/dist/client/system/processors/nui.processor.js +40 -0
  83. package/dist/client/system/processors/resourceLifecycle.processor.d.ts +9 -0
  84. package/dist/client/system/processors/resourceLifecycle.processor.js +69 -0
  85. package/dist/client/system/processors/tick.processor.d.ts +5 -0
  86. package/dist/client/system/processors/tick.processor.js +37 -0
  87. package/dist/client/system/processors.register.d.ts +1 -0
  88. package/dist/client/system/processors.register.js +27 -0
  89. package/dist/client/types/game-events.d.ts +126 -0
  90. package/dist/client/types/game-events.js +83 -0
  91. package/dist/client/types/index.d.ts +1 -0
  92. package/dist/client/types/index.js +17 -0
  93. package/dist/client/ui-bridge.d.ts +116 -0
  94. package/dist/client/ui-bridge.js +201 -0
  95. package/dist/index.d.ts +7 -0
  96. package/dist/index.js +46 -0
  97. package/dist/server/bootstrap.d.ts +16 -0
  98. package/dist/server/bootstrap.js +57 -0
  99. package/dist/server/bus/core-event-bus.d.ts +6 -0
  100. package/dist/server/bus/core-event-bus.js +31 -0
  101. package/dist/server/configs/api.config.d.ts +71 -0
  102. package/dist/server/configs/api.config.js +81 -0
  103. package/dist/server/configs/config.base.d.ts +63 -0
  104. package/dist/server/configs/config.base.js +64 -0
  105. package/dist/server/configs/index.d.ts +2 -0
  106. package/dist/server/configs/index.js +18 -0
  107. package/dist/server/container.d.ts +2 -0
  108. package/dist/server/container.js +6 -0
  109. package/dist/server/controllers/chat.controller.d.ts +10 -0
  110. package/dist/server/controllers/chat.controller.js +50 -0
  111. package/dist/server/controllers/command.controller.d.ts +7 -0
  112. package/dist/server/controllers/command.controller.js +47 -0
  113. package/dist/server/core.d.ts +1 -0
  114. package/dist/server/core.js +7 -0
  115. package/dist/server/database/adapters/oxmysql.adapter.d.ts +89 -0
  116. package/dist/server/database/adapters/oxmysql.adapter.js +149 -0
  117. package/dist/server/database/database.contract.d.ts +128 -0
  118. package/dist/server/database/database.contract.js +29 -0
  119. package/dist/server/database/database.service.d.ts +216 -0
  120. package/dist/server/database/database.service.js +301 -0
  121. package/dist/server/database/index.d.ts +53 -0
  122. package/dist/server/database/index.js +70 -0
  123. package/dist/server/database/types.d.ts +67 -0
  124. package/dist/server/database/types.js +7 -0
  125. package/dist/server/database.d.ts +7 -0
  126. package/dist/server/database.js +23 -0
  127. package/dist/server/decorators/bind.d.ts +2 -0
  128. package/dist/server/decorators/bind.js +15 -0
  129. package/dist/server/decorators/command.d.ts +19 -0
  130. package/dist/server/decorators/command.js +18 -0
  131. package/dist/server/decorators/controller.d.ts +3 -0
  132. package/dist/server/decorators/controller.js +14 -0
  133. package/dist/server/decorators/coreEvent.d.ts +2 -0
  134. package/dist/server/decorators/coreEvent.js +9 -0
  135. package/dist/server/decorators/export.d.ts +1 -0
  136. package/dist/server/decorators/export.js +9 -0
  137. package/dist/server/decorators/guard.d.ts +5 -0
  138. package/dist/server/decorators/guard.js +39 -0
  139. package/dist/server/decorators/index.d.ts +10 -0
  140. package/dist/server/decorators/index.js +26 -0
  141. package/dist/server/decorators/netEvent.d.ts +36 -0
  142. package/dist/server/decorators/netEvent.js +40 -0
  143. package/dist/server/decorators/onTick.d.ts +1 -0
  144. package/dist/server/decorators/onTick.js +9 -0
  145. package/dist/server/decorators/public.d.ts +16 -0
  146. package/dist/server/decorators/public.js +25 -0
  147. package/dist/server/decorators/requiresState.d.ts +55 -0
  148. package/dist/server/decorators/requiresState.js +62 -0
  149. package/dist/server/decorators/throttle.d.ts +9 -0
  150. package/dist/server/decorators/throttle.js +36 -0
  151. package/dist/server/decorators/utils.d.ts +7 -0
  152. package/dist/server/decorators/utils.js +13 -0
  153. package/dist/server/entities/index.d.ts +1 -0
  154. package/dist/server/entities/index.js +17 -0
  155. package/dist/server/entities/player.d.ts +157 -0
  156. package/dist/server/entities/player.js +217 -0
  157. package/dist/server/error-handler.d.ts +2 -0
  158. package/dist/server/error-handler.js +43 -0
  159. package/dist/server/index.d.ts +10 -0
  160. package/dist/server/index.js +29 -0
  161. package/dist/server/loaders/exports.loader.d.ts +0 -0
  162. package/dist/server/loaders/exports.loader.js +23 -0
  163. package/dist/server/loaders/playerSession.loader.d.ts +1 -0
  164. package/dist/server/loaders/playerSession.loader.js +42 -0
  165. package/dist/server/services/access-control.service.d.ts +56 -0
  166. package/dist/server/services/access-control.service.js +99 -0
  167. package/dist/server/services/chat.service.d.ts +7 -0
  168. package/dist/server/services/chat.service.js +31 -0
  169. package/dist/server/services/command.service.d.ts +15 -0
  170. package/dist/server/services/command.service.js +74 -0
  171. package/dist/server/services/config.service.d.ts +75 -0
  172. package/dist/server/services/config.service.js +116 -0
  173. package/dist/server/services/default/default-security.handler.d.ts +6 -0
  174. package/dist/server/services/default/default-security.handler.js +26 -0
  175. package/dist/server/services/http/http.service.d.ts +50 -0
  176. package/dist/server/services/http/http.service.js +126 -0
  177. package/dist/server/services/index.d.ts +10 -0
  178. package/dist/server/services/index.js +26 -0
  179. package/dist/server/services/parallel/index.d.ts +49 -0
  180. package/dist/server/services/parallel/index.js +67 -0
  181. package/dist/server/services/parallel/parallel-compute.service.d.ts +132 -0
  182. package/dist/server/services/parallel/parallel-compute.service.js +449 -0
  183. package/dist/server/services/parallel/types.d.ts +188 -0
  184. package/dist/server/services/parallel/types.js +7 -0
  185. package/dist/server/services/parallel/worker-pool.d.ts +83 -0
  186. package/dist/server/services/parallel/worker-pool.js +350 -0
  187. package/dist/server/services/parallel/worker.d.ts +19 -0
  188. package/dist/server/services/parallel/worker.js +49 -0
  189. package/dist/server/services/persistence.service.d.ts +59 -0
  190. package/dist/server/services/persistence.service.js +166 -0
  191. package/dist/server/services/player.service.d.ts +96 -0
  192. package/dist/server/services/player.service.js +132 -0
  193. package/dist/server/services/rate-limiter.service.d.ts +5 -0
  194. package/dist/server/services/rate-limiter.service.js +39 -0
  195. package/dist/server/services/registers.d.ts +1 -0
  196. package/dist/server/services/registers.js +18 -0
  197. package/dist/server/setup.d.ts +9 -0
  198. package/dist/server/setup.js +28 -0
  199. package/dist/server/system/metadata-server.keys.d.ts +9 -0
  200. package/dist/server/system/metadata-server.keys.js +12 -0
  201. package/dist/server/system/processors/command.processor.d.ts +9 -0
  202. package/dist/server/system/processors/command.processor.js +31 -0
  203. package/dist/server/system/processors/coreEvent.processor.d.ts +7 -0
  204. package/dist/server/system/processors/coreEvent.processor.js +38 -0
  205. package/dist/server/system/processors/export.processor.d.ts +7 -0
  206. package/dist/server/system/processors/export.processor.js +26 -0
  207. package/dist/server/system/processors/netEvent.processor.d.ts +11 -0
  208. package/dist/server/system/processors/netEvent.processor.js +100 -0
  209. package/dist/server/system/processors/tick.processor.d.ts +5 -0
  210. package/dist/server/system/processors/tick.processor.js +36 -0
  211. package/dist/server/system/processors.register.d.ts +1 -0
  212. package/dist/server/system/processors.register.js +21 -0
  213. package/dist/server/templates/admin/admin.controller-template.d.ts +10 -0
  214. package/dist/server/templates/admin/admin.controller-template.js +2 -0
  215. package/dist/server/templates/auth/auth-provider.contract.d.ts +58 -0
  216. package/dist/server/templates/auth/auth-provider.contract.js +23 -0
  217. package/dist/server/templates/index.d.ts +8 -0
  218. package/dist/server/templates/index.js +21 -0
  219. package/dist/server/templates/persistence/index.d.ts +30 -0
  220. package/dist/server/templates/persistence/index.js +34 -0
  221. package/dist/server/templates/persistence/player-persistence.contract.d.ts +86 -0
  222. package/dist/server/templates/persistence/player-persistence.contract.js +52 -0
  223. package/dist/server/templates/repository/index.d.ts +57 -0
  224. package/dist/server/templates/repository/index.js +61 -0
  225. package/dist/server/templates/repository/repository.contract.d.ts +224 -0
  226. package/dist/server/templates/repository/repository.contract.js +342 -0
  227. package/dist/server/templates/repository/repository.types.d.ts +51 -0
  228. package/dist/server/templates/repository/repository.types.js +7 -0
  229. package/dist/server/templates/security/permission.types.d.ts +32 -0
  230. package/dist/server/templates/security/permission.types.js +2 -0
  231. package/dist/server/templates/security/principal-provider.contract.d.ts +43 -0
  232. package/dist/server/templates/security/principal-provider.contract.js +19 -0
  233. package/dist/server/templates/security/security-handler.contract.d.ts +5 -0
  234. package/dist/server/templates/security/security-handler.contract.js +6 -0
  235. package/dist/server/types/core-events.d.ts +17 -0
  236. package/dist/server/types/core-events.js +2 -0
  237. package/dist/server/types/security.types.d.ts +7 -0
  238. package/dist/server/types/security.types.js +2 -0
  239. package/dist/shared/index.d.ts +1 -0
  240. package/dist/shared/index.js +17 -0
  241. package/dist/shared/logger/core-logger.d.ts +35 -0
  242. package/dist/shared/logger/core-logger.js +52 -0
  243. package/dist/shared/logger/index.d.ts +11 -0
  244. package/dist/shared/logger/index.js +26 -0
  245. package/dist/shared/logger/logger.config.d.ts +47 -0
  246. package/dist/shared/logger/logger.config.js +33 -0
  247. package/dist/shared/logger/logger.service.d.ts +161 -0
  248. package/dist/shared/logger/logger.service.js +279 -0
  249. package/dist/shared/logger/logger.types.d.ts +85 -0
  250. package/dist/shared/logger/logger.types.js +74 -0
  251. package/dist/shared/logger/transports/buffered.transport.d.ts +88 -0
  252. package/dist/shared/logger/transports/buffered.transport.js +174 -0
  253. package/dist/shared/logger/transports/console.transport.d.ts +37 -0
  254. package/dist/shared/logger/transports/console.transport.js +134 -0
  255. package/dist/shared/logger/transports/index.d.ts +3 -0
  256. package/dist/shared/logger/transports/index.js +19 -0
  257. package/dist/shared/logger/transports/transport.interface.d.ts +40 -0
  258. package/dist/shared/logger/transports/transport.interface.js +2 -0
  259. package/dist/system/class-constructor.d.ts +1 -0
  260. package/dist/system/class-constructor.js +2 -0
  261. package/dist/system/decorator-processor.d.ts +4 -0
  262. package/dist/system/decorator-processor.js +2 -0
  263. package/dist/system/metadata.scanner.d.ts +7 -0
  264. package/dist/system/metadata.scanner.js +45 -0
  265. package/dist/utils/errors.d.ts +14 -0
  266. package/dist/utils/errors.js +25 -0
  267. package/dist/utils/index.d.ts +4 -0
  268. package/dist/utils/index.js +20 -0
  269. package/dist/utils/result.d.ts +12 -0
  270. package/dist/utils/result.js +10 -0
  271. package/dist/utils/rgb.d.ts +5 -0
  272. package/dist/utils/rgb.js +2 -0
  273. package/dist/utils/vector3.d.ts +13 -0
  274. package/dist/utils/vector3.js +27 -0
  275. package/package.json +70 -0
@@ -0,0 +1,201 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.NUI = exports.NuiBridge = void 0;
10
+ const tsyringe_1 = require("tsyringe");
11
+ const logger_1 = require("../shared/logger");
12
+ const nuiLogger = logger_1.coreLogger.child('NUI', logger_1.LogDomain.CLIENT);
13
+ /**
14
+ * Type-safe NUI (Native UI) Bridge for client-server communication.
15
+ *
16
+ * Generic types allow for full type safety when sending/receiving messages.
17
+ * Define your event maps and pass them as type parameters.
18
+ *
19
+ * @example
20
+ * ```typescript
21
+ * interface ClientToUI {
22
+ * 'showMenu': { items: string[] }
23
+ * 'hideMenu': void
24
+ * }
25
+ *
26
+ * interface UIToClient {
27
+ * 'menuItemSelected': { index: number }
28
+ * 'menuClosed': void
29
+ * }
30
+ *
31
+ * const nui = new NuiBridge<ClientToUI, UIToClient>()
32
+ * nui.send('showMenu', { items: ['Option 1', 'Option 2'] })
33
+ * nui.on('menuItemSelected', async (data) => console.log(data.index))
34
+ * ```
35
+ */
36
+ let NuiBridge = class NuiBridge {
37
+ constructor() {
38
+ this._isVisible = false;
39
+ this._hasFocus = false;
40
+ this._hasCursor = false;
41
+ }
42
+ /**
43
+ * Whether the NUI frame is currently visible
44
+ */
45
+ get isVisible() {
46
+ return this._isVisible;
47
+ }
48
+ /**
49
+ * Whether the NUI has input focus
50
+ */
51
+ get hasFocus() {
52
+ return this._hasFocus;
53
+ }
54
+ /**
55
+ * Whether the cursor is visible
56
+ */
57
+ get hasCursor() {
58
+ return this._hasCursor;
59
+ }
60
+ /**
61
+ * Send a message to the NUI (UI frame).
62
+ *
63
+ * @param action - The action/event name
64
+ * @param data - The data payload
65
+ */
66
+ send(action, data) {
67
+ SendNuiMessage(JSON.stringify({ action, data }));
68
+ nuiLogger.debug(`Sent message: ${action}`);
69
+ }
70
+ /**
71
+ * Send a raw message to the NUI without type checking.
72
+ *
73
+ * @param action - The action/event name
74
+ * @param data - The data payload
75
+ */
76
+ sendRaw(action, data) {
77
+ SendNuiMessage(JSON.stringify({ action, data }));
78
+ nuiLogger.debug(`Sent raw message: ${action}`);
79
+ }
80
+ /**
81
+ * Register a callback for NUI events from the UI.
82
+ *
83
+ * @param action - The action/event name to listen for
84
+ * @param handler - The callback handler
85
+ * @returns Cleanup function to unregister the callback
86
+ */
87
+ on(action, handler) {
88
+ RegisterNuiCallbackType(action);
89
+ on(`__cfx_nui:${action}`, async (data, cb) => {
90
+ try {
91
+ await handler(data);
92
+ cb({ ok: true });
93
+ }
94
+ catch (error) {
95
+ nuiLogger.error(`NUI callback error`, { action }, error);
96
+ cb({ ok: false, error: String(error) });
97
+ }
98
+ });
99
+ nuiLogger.debug(`Registered callback: ${action}`);
100
+ }
101
+ /**
102
+ * Register a callback that expects a return value.
103
+ *
104
+ * @param action - The action/event name to listen for
105
+ * @param handler - The callback handler that returns data
106
+ */
107
+ onWithResponse(action, handler) {
108
+ RegisterNuiCallbackType(action);
109
+ on(`__cfx_nui:${action}`, async (data, cb) => {
110
+ try {
111
+ const result = await handler(data);
112
+ cb({ ok: true, data: result });
113
+ }
114
+ catch (error) {
115
+ nuiLogger.error(`NUI callback error`, { action }, error);
116
+ cb({ ok: false, error: String(error) });
117
+ }
118
+ });
119
+ nuiLogger.debug(`Registered callback with response: ${action}`);
120
+ }
121
+ /**
122
+ * Set NUI focus state.
123
+ *
124
+ * @param hasFocus - Whether the NUI should have input focus
125
+ * @param hasCursor - Whether to show the cursor (defaults to hasFocus value)
126
+ */
127
+ focus(hasFocus, hasCursor) {
128
+ this._hasFocus = hasFocus;
129
+ this._hasCursor = hasCursor !== null && hasCursor !== void 0 ? hasCursor : hasFocus;
130
+ SetNuiFocus(this._hasFocus, this._hasCursor);
131
+ nuiLogger.debug(`Focus set: focus=${this._hasFocus}, cursor=${this._hasCursor}`);
132
+ }
133
+ /**
134
+ * Remove NUI focus (convenience method).
135
+ */
136
+ blur() {
137
+ this.focus(false, false);
138
+ }
139
+ /**
140
+ * Set NUI visibility state.
141
+ * Note: This only tracks state, you need to handle actual visibility in your UI.
142
+ *
143
+ * @param visible - Whether the NUI should be visible
144
+ */
145
+ setVisible(visible) {
146
+ this._isVisible = visible;
147
+ this.send('setVisible', { visible });
148
+ nuiLogger.debug(`Visibility set: ${visible}`);
149
+ }
150
+ /**
151
+ * Show the NUI and optionally set focus.
152
+ *
153
+ * @param withFocus - Whether to also set focus
154
+ * @param withCursor - Whether to show cursor (defaults to withFocus)
155
+ */
156
+ show(withFocus = true, withCursor) {
157
+ this.setVisible(true);
158
+ if (withFocus) {
159
+ this.focus(true, withCursor);
160
+ }
161
+ }
162
+ /**
163
+ * Hide the NUI and remove focus.
164
+ */
165
+ hide() {
166
+ this.setVisible(false);
167
+ this.blur();
168
+ }
169
+ /**
170
+ * Toggle NUI visibility.
171
+ *
172
+ * @param withFocus - Whether to set focus when showing
173
+ */
174
+ toggle(withFocus = true) {
175
+ if (this._isVisible) {
176
+ this.hide();
177
+ }
178
+ else {
179
+ this.show(withFocus);
180
+ }
181
+ }
182
+ /**
183
+ * Keep input focus but allow game input.
184
+ * Useful for HUDs that need to capture some keys but not all.
185
+ *
186
+ * @param keepInput - Whether to keep game input enabled
187
+ */
188
+ setKeepInput(keepInput) {
189
+ SetNuiFocusKeepInput(keepInput);
190
+ nuiLogger.debug(`Keep input set: ${keepInput}`);
191
+ }
192
+ };
193
+ exports.NuiBridge = NuiBridge;
194
+ exports.NuiBridge = NuiBridge = __decorate([
195
+ (0, tsyringe_1.injectable)()
196
+ ], NuiBridge);
197
+ /**
198
+ * Default untyped NUI instance for quick usage.
199
+ * For type-safe usage, create your own instance with proper generics.
200
+ */
201
+ exports.NUI = new NuiBridge();
@@ -0,0 +1,7 @@
1
+ import 'reflect-metadata';
2
+ export * as Utils from './utils';
3
+ export * as Shared from './shared';
4
+ export * as Server from './server';
5
+ export * as Client from './client';
6
+ export { LoggerService, LogLevel, LogDomain } from './shared/logger';
7
+ export type { LogTransport, LogContext, LogEntry, LoggerConfig } from './shared/logger';
package/dist/index.js ADDED
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.LogDomain = exports.LogLevel = exports.LoggerService = exports.Client = exports.Server = exports.Shared = exports.Utils = void 0;
37
+ require("reflect-metadata");
38
+ exports.Utils = __importStar(require("./utils"));
39
+ exports.Shared = __importStar(require("./shared"));
40
+ exports.Server = __importStar(require("./server"));
41
+ exports.Client = __importStar(require("./client"));
42
+ // Re-export logger at root level for convenience
43
+ var logger_1 = require("./shared/logger");
44
+ Object.defineProperty(exports, "LoggerService", { enumerable: true, get: function () { return logger_1.LoggerService; } });
45
+ Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_1.LogLevel; } });
46
+ Object.defineProperty(exports, "LogDomain", { enumerable: true, get: function () { return logger_1.LogDomain; } });
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Bootstraps the OpenCore Server Application Context.
3
+ *
4
+ * This is the primary entry point for the server-side framework. It orchestrates the
5
+ * initialization of the Dependency Injection (DI) container and establishes the
6
+ * bridge between the low-level FiveM runtime and the OpenCore architecture.
7
+ *
8
+ * **Initialization Lifecycle:**
9
+ * 1. **Infrastructure Registration:** Registers core infrastructure services (`PlayerService`, `CommandService`, `HttpService`) as Singletons in the IoC container.
10
+ * 2. **Reflection & Discovery:** Scans all decorated classes (Controllers, Services) to extract metadata defined by `@Command`, `@OnNet`, etc.
11
+ * 3. **Runtime Binding:** Binds the discovered metadata to actual FiveM natives (e.g., `RegisterCommand`, `onNet`, `exports`).
12
+ * 4. **Session Management:** Activates the player session tracking system.
13
+ *
14
+ * @returns A promise that resolves when the Core is fully initialized and ready to process events.
15
+ */
16
+ export declare function initServer(): Promise<void>;
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.initServer = initServer;
4
+ const container_1 = require("./container");
5
+ const playerSession_loader_1 = require("./loaders/playerSession.loader");
6
+ const templates_1 = require("./templates");
7
+ const metadata_scanner_1 = require("../system/metadata.scanner");
8
+ const processors_register_1 = require("./system/processors.register");
9
+ const registers_1 = require("./services/registers");
10
+ const decorators_1 = require("./decorators");
11
+ const logger_1 = require("../shared/logger");
12
+ const auth_provider_contract_1 = require("./templates/auth/auth-provider.contract");
13
+ const check = () => {
14
+ if (!container_1.di.isRegistered(templates_1.PrincipalProviderContract)) {
15
+ const errorMsg = 'No Principal Provider configured. ' +
16
+ "Please call 'Server.setPrincipalProvider(YourProvider)' before init(). This is required for authentication and authorization.";
17
+ logger_1.loggers.bootstrap.fatal(errorMsg);
18
+ throw new Error(`[OpenCore] CRITICAL: ${errorMsg}`);
19
+ }
20
+ if (!container_1.di.isRegistered(auth_provider_contract_1.AuthProviderContract)) {
21
+ const errorMsg = 'No Authentication Provider configured. ' +
22
+ "Please call 'Server.setAuthProvider(YourProvider)' before init(). This is required for authentication and authorization.";
23
+ logger_1.loggers.bootstrap.fatal(errorMsg);
24
+ throw new Error(`[OpenCore] CRITICAL: ${errorMsg}`);
25
+ }
26
+ };
27
+ /**
28
+ * Bootstraps the OpenCore Server Application Context.
29
+ *
30
+ * This is the primary entry point for the server-side framework. It orchestrates the
31
+ * initialization of the Dependency Injection (DI) container and establishes the
32
+ * bridge between the low-level FiveM runtime and the OpenCore architecture.
33
+ *
34
+ * **Initialization Lifecycle:**
35
+ * 1. **Infrastructure Registration:** Registers core infrastructure services (`PlayerService`, `CommandService`, `HttpService`) as Singletons in the IoC container.
36
+ * 2. **Reflection & Discovery:** Scans all decorated classes (Controllers, Services) to extract metadata defined by `@Command`, `@OnNet`, etc.
37
+ * 3. **Runtime Binding:** Binds the discovered metadata to actual FiveM natives (e.g., `RegisterCommand`, `onNet`, `exports`).
38
+ * 4. **Session Management:** Activates the player session tracking system.
39
+ *
40
+ * @returns A promise that resolves when the Core is fully initialized and ready to process events.
41
+ */
42
+ async function initServer() {
43
+ logger_1.loggers.bootstrap.info('Initializing OpenCore Server...');
44
+ check();
45
+ // Register core services
46
+ (0, registers_1.registerServicesServer)();
47
+ logger_1.loggers.bootstrap.debug('Core services registered');
48
+ // Register system processors
49
+ (0, processors_register_1.registerSystemServer)();
50
+ logger_1.loggers.bootstrap.debug('System processors registered');
51
+ // Extras
52
+ (0, playerSession_loader_1.playerSessionLoader)();
53
+ logger_1.loggers.bootstrap.debug('Player session loader active');
54
+ const scanner = container_1.di.resolve(metadata_scanner_1.MetadataScanner);
55
+ scanner.scan(decorators_1.serverControllerRegistry);
56
+ logger_1.loggers.bootstrap.info('OpenCore Server initialized successfully');
57
+ }
@@ -0,0 +1,6 @@
1
+ import type { CoreEventMap } from '../types/core-events';
2
+ type CoreEventName = keyof CoreEventMap;
3
+ type CoreEventHandler<E extends CoreEventName> = (payload: CoreEventMap[E]) => void;
4
+ export declare function onCoreEvent<E extends CoreEventName>(event: E, handler: CoreEventHandler<E>): () => void;
5
+ export declare function emitCoreEvent<E extends CoreEventName>(event: E, payload: CoreEventMap[E]): void;
6
+ export {};
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.onCoreEvent = onCoreEvent;
4
+ exports.emitCoreEvent = emitCoreEvent;
5
+ const logger_1 = require("../../shared/logger");
6
+ const handlers = {};
7
+ function onCoreEvent(event, handler) {
8
+ var _a;
9
+ const list = ((_a = handlers[event]) !== null && _a !== void 0 ? _a : (handlers[event] = []));
10
+ list.push(handler);
11
+ return () => {
12
+ const index = list.indexOf(handler);
13
+ if (index !== -1)
14
+ list.splice(index, 1);
15
+ };
16
+ }
17
+ function emitCoreEvent(event, payload) {
18
+ const list = handlers[event];
19
+ if (!list)
20
+ return;
21
+ for (const handler of list) {
22
+ try {
23
+ handler(payload);
24
+ }
25
+ catch (error) {
26
+ logger_1.loggers.eventBus.error(`Handler error for event`, {
27
+ event,
28
+ }, error);
29
+ }
30
+ }
31
+ }
@@ -0,0 +1,71 @@
1
+ import { FluentConfigurator } from './config.base';
2
+ interface ApiConfigState {
3
+ baseUrl: string;
4
+ timeoutMs: number;
5
+ }
6
+ /**
7
+ * Extended configurator interface for API configuration.
8
+ *
9
+ * Extends the base fluent configurator with additional methods
10
+ * specific to API configuration (like addHeader).
11
+ */
12
+ export interface ApiConfigurator extends FluentConfigurator<ApiConfigState> {
13
+ /**
14
+ * Alias for timeoutMs - sets the timeout in milliseconds.
15
+ * @param ms - Timeout duration in milliseconds.
16
+ */
17
+ timeout(ms: number): this;
18
+ /**
19
+ * Adds a default header to be included in every API request.
20
+ * @param key - The HTTP header name (e.g., "Authorization").
21
+ * @param value - The header value.
22
+ */
23
+ addHeader(key: string, value: string): this;
24
+ }
25
+ /**
26
+ * Configuration service for the Core API module.
27
+ *
28
+ * It follows a "Convention over Configuration" approach:
29
+ * 1. By default, it loads values from FiveM Convars (`opencore_api_url`, `opencore_api_timeout`).
30
+ * 2. It can be programmatically overridden using the `configure()` method.
31
+ *
32
+ * @scope Singleton
33
+ */
34
+ export declare class ApiConfig {
35
+ private state;
36
+ private _headers;
37
+ /**
38
+ * Applies programmatic configuration using a functional builder pattern.
39
+ *
40
+ * This method allows developers to override default settings or inject dynamic configuration
41
+ * logic during the server startup phase.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * const apiConfig = di.resolve(ApiConfig);
46
+ * apiConfig.configure(c =>
47
+ * c.baseUrl('https://api.production.com')
48
+ * .timeout(10000)
49
+ * .addHeader('X-API-Key', 'secret')
50
+ * );
51
+ * ```
52
+ *
53
+ * @param configFn - A callback function that receives the configurator instance.
54
+ */
55
+ configure(configFn: (config: ApiConfigurator) => void): void;
56
+ /**
57
+ * Gets the currently configured Base URL.
58
+ */
59
+ get baseUrl(): string;
60
+ /**
61
+ * Gets the configured timeout in milliseconds.
62
+ */
63
+ get timeoutMs(): number;
64
+ /**
65
+ * Gets a copy of the globally configured headers.
66
+ */
67
+ get headers(): {
68
+ [x: string]: string;
69
+ };
70
+ }
71
+ export {};
@@ -0,0 +1,81 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.ApiConfig = void 0;
10
+ const decorators_1 = require("../decorators");
11
+ const config_base_1 = require("./config.base");
12
+ /**
13
+ * Configuration service for the Core API module.
14
+ *
15
+ * It follows a "Convention over Configuration" approach:
16
+ * 1. By default, it loads values from FiveM Convars (`opencore_api_url`, `opencore_api_timeout`).
17
+ * 2. It can be programmatically overridden using the `configure()` method.
18
+ *
19
+ * @scope Singleton
20
+ */
21
+ let ApiConfig = class ApiConfig {
22
+ constructor() {
23
+ this.state = {
24
+ baseUrl: GetConvar('opencore_api_url', 'http://localhost:3000'),
25
+ timeoutMs: Number(GetConvar('opencore_api_timeout', '5000')),
26
+ };
27
+ this._headers = {};
28
+ }
29
+ /**
30
+ * Applies programmatic configuration using a functional builder pattern.
31
+ *
32
+ * This method allows developers to override default settings or inject dynamic configuration
33
+ * logic during the server startup phase.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const apiConfig = di.resolve(ApiConfig);
38
+ * apiConfig.configure(c =>
39
+ * c.baseUrl('https://api.production.com')
40
+ * .timeout(10000)
41
+ * .addHeader('X-API-Key', 'secret')
42
+ * );
43
+ * ```
44
+ *
45
+ * @param configFn - A callback function that receives the configurator instance.
46
+ */
47
+ configure(configFn) {
48
+ const baseConfigurator = (0, config_base_1.createFluentConfigurator)(this.state);
49
+ // Extend with custom methods
50
+ const configurator = Object.assign(Object.assign({}, baseConfigurator), { timeout: (ms) => {
51
+ this.state.timeoutMs = ms;
52
+ return configurator;
53
+ }, addHeader: (key, value) => {
54
+ this._headers[key] = value;
55
+ return configurator;
56
+ } });
57
+ configFn(configurator);
58
+ }
59
+ /**
60
+ * Gets the currently configured Base URL.
61
+ */
62
+ get baseUrl() {
63
+ return this.state.baseUrl;
64
+ }
65
+ /**
66
+ * Gets the configured timeout in milliseconds.
67
+ */
68
+ get timeoutMs() {
69
+ return this.state.timeoutMs;
70
+ }
71
+ /**
72
+ * Gets a copy of the globally configured headers.
73
+ */
74
+ get headers() {
75
+ return Object.assign({}, this._headers);
76
+ }
77
+ };
78
+ exports.ApiConfig = ApiConfig;
79
+ exports.ApiConfig = ApiConfig = __decorate([
80
+ (0, decorators_1.Bind)('singleton')
81
+ ], ApiConfig);
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Fluent Configuration Utilities
3
+ *
4
+ * Provides utilities for creating Spring Boot-style fluent configuration APIs.
5
+ * This enables method chaining for cleaner configuration syntax.
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * interface MyConfigState {
10
+ * host: string
11
+ * port: number
12
+ * enabled: boolean
13
+ * }
14
+ *
15
+ * const state: MyConfigState = { host: 'localhost', port: 3000, enabled: true }
16
+ * const configurator = createFluentConfigurator(state)
17
+ *
18
+ * configurator
19
+ * .host('api.example.com')
20
+ * .port(8080)
21
+ * .enabled(false)
22
+ * ```
23
+ */
24
+ /**
25
+ * Type that transforms a state object into a fluent configurator interface.
26
+ *
27
+ * Each property becomes a method that:
28
+ * - Accepts a value of the same type as the original property
29
+ * - Returns the configurator for method chaining
30
+ *
31
+ * @template T - The state object type
32
+ */
33
+ export type FluentConfigurator<T> = {
34
+ [K in keyof T]: (value: T[K]) => FluentConfigurator<T>;
35
+ };
36
+ /**
37
+ * Creates a fluent configurator from a state object.
38
+ *
39
+ * The configurator allows method chaining to set values on the state object.
40
+ * Each property of the state becomes a method on the configurator.
41
+ *
42
+ * @template T - The state object type
43
+ * @param state - The state object to configure (will be mutated)
44
+ * @returns A fluent configurator with chainable methods
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * interface ApiState {
49
+ * baseUrl: string
50
+ * timeout: number
51
+ * }
52
+ *
53
+ * const state: ApiState = { baseUrl: '', timeout: 5000 }
54
+ *
55
+ * createFluentConfigurator(state)
56
+ * .baseUrl('https://api.example.com')
57
+ * .timeout(10000)
58
+ *
59
+ * console.log(state.baseUrl) // 'https://api.example.com'
60
+ * console.log(state.timeout) // 10000
61
+ * ```
62
+ */
63
+ export declare function createFluentConfigurator<T extends object>(state: T): FluentConfigurator<T>;
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+ /**
3
+ * Fluent Configuration Utilities
4
+ *
5
+ * Provides utilities for creating Spring Boot-style fluent configuration APIs.
6
+ * This enables method chaining for cleaner configuration syntax.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * interface MyConfigState {
11
+ * host: string
12
+ * port: number
13
+ * enabled: boolean
14
+ * }
15
+ *
16
+ * const state: MyConfigState = { host: 'localhost', port: 3000, enabled: true }
17
+ * const configurator = createFluentConfigurator(state)
18
+ *
19
+ * configurator
20
+ * .host('api.example.com')
21
+ * .port(8080)
22
+ * .enabled(false)
23
+ * ```
24
+ */
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.createFluentConfigurator = createFluentConfigurator;
27
+ /**
28
+ * Creates a fluent configurator from a state object.
29
+ *
30
+ * The configurator allows method chaining to set values on the state object.
31
+ * Each property of the state becomes a method on the configurator.
32
+ *
33
+ * @template T - The state object type
34
+ * @param state - The state object to configure (will be mutated)
35
+ * @returns A fluent configurator with chainable methods
36
+ *
37
+ * @example
38
+ * ```ts
39
+ * interface ApiState {
40
+ * baseUrl: string
41
+ * timeout: number
42
+ * }
43
+ *
44
+ * const state: ApiState = { baseUrl: '', timeout: 5000 }
45
+ *
46
+ * createFluentConfigurator(state)
47
+ * .baseUrl('https://api.example.com')
48
+ * .timeout(10000)
49
+ *
50
+ * console.log(state.baseUrl) // 'https://api.example.com'
51
+ * console.log(state.timeout) // 10000
52
+ * ```
53
+ */
54
+ function createFluentConfigurator(state) {
55
+ const configurator = {};
56
+ for (const key of Object.keys(state)) {
57
+ ;
58
+ configurator[key] = (value) => {
59
+ state[key] = value;
60
+ return configurator;
61
+ };
62
+ }
63
+ return configurator;
64
+ }
@@ -0,0 +1,2 @@
1
+ export * from './api.config';
2
+ export * from './config.base';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./api.config"), exports);
18
+ __exportStar(require("./config.base"), exports);
@@ -0,0 +1,2 @@
1
+ import 'reflect-metadata';
2
+ export declare const di: import("tsyringe").DependencyContainer;