@armoury/fivem-framework-client 1.0.37 → 1.0.38

package/dist/cjs/client/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLIENT_PROVIDERS = void 0;
+exports.CLIENT_EAGER_PROVIDERS = exports.CLIENT_PROVIDERS = void 0;
 exports.bootstrap = bootstrap;
 require("reflect-metadata");
 const services_1 = require("./services");
@@ -33,8 +33,11 @@ exports.CLIENT_PROVIDERS = [
     services_1.ClientUIService,
     services_1.ClientWaypointsService,
 ];
+exports.CLIENT_EAGER_PROVIDERS = [
+    services_1.UI
+];
 async function bootstrap(_class, options = {}) {
-    return (0, fivem_framework_common_1.bootstrapWithProviders)(_class, exports.CLIENT_PROVIDERS, options, fivem_framework_common_1.DecorationType.CLIENT, (key, index) => Cfx.Client.GetResourceMetadata(Cfx.Client.GetCurrentResourceName(), key, index), (resourceName) => Cfx.exports[resourceName]);
+    return (0, fivem_framework_common_1.bootstrapWithProviders)(_class, exports.CLIENT_PROVIDERS, options, fivem_framework_common_1.DecorationType.CLIENT, (key, index) => Cfx.Client.GetResourceMetadata(Cfx.Client.GetCurrentResourceName(), key, index), (resourceName) => Cfx.exports[resourceName], exports.CLIENT_EAGER_PROVIDERS);
 }
 __exportStar(require("./services"), exports);
 __exportStar(require("@armoury/fivem-framework-common"), exports);

package/dist/cjs/client/services/index.js

@@ -26,3 +26,4 @@ __exportStar(require("./client-translate.service"), exports);
 __exportStar(require("./client-vehicles.service"), exports);
 __exportStar(require("./client-ui.service"), exports);
 __exportStar(require("./client-waypoints.service"), exports);
+__exportStar(require("./ui"), exports);

package/dist/cjs/client/services/ui/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ui"), exports);

package/dist/cjs/client/services/ui/ui.js

@@ -0,0 +1,43 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var UI_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UI = void 0;
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+const injection_js_1 = require("injection-js");
+let UI = UI_1 = class UI {
+    constructor(armouryRef) {
+        UI_1.armouryRef = armouryRef;
+    }
+    static sendMessage(message) {
+        if (!isUIMessage(message)) {
+            console.error('Couldn\'t send UI message: Message doesn\'t respect a valid format.', 'Message:', message);
+            return;
+        }
+        this.armouryRef.instance.sendUIMessage(message);
+    }
+};
+exports.UI = UI;
+exports.UI = UI = UI_1 = __decorate([
+    (0, injection_js_1.Injectable)(),
+    __param(0, (0, fivem_framework_common_1.Resource)('armoury')),
+    __metadata("design:paramtypes", [fivem_framework_common_1.ResourceRef])
+], UI);
+function isUIMessage(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        !Array.isArray(value) &&
+        "type" in value &&
+        typeof value.type === "string");
+}

package/dist/esm/client/index.js

@@ -1,6 +1,6 @@
 /// <reference path = "../ambient.declarations.d.ts" />
 import 'reflect-metadata';
-import { ClientActionPointsService, ClientBlipsService, ClientCheckpointsService, ClientMarkersService, ClientPedsService, ClientSessionService, ClientTicksService, ClientUIService, ClientVehiclesService, ClientWaypointsService, ClientHudService } from './services';
+import { ClientActionPointsService, ClientBlipsService, ClientCheckpointsService, ClientMarkersService, ClientPedsService, ClientSessionService, ClientTicksService, ClientUIService, ClientVehiclesService, ClientWaypointsService, ClientHudService, UI } from './services';
 import { bootstrapWithProviders, DecorationType } from '@armoury/fivem-framework-common';
 export const CLIENT_PROVIDERS = [
     ClientActionPointsService,
@@ -15,8 +15,11 @@ export const CLIENT_PROVIDERS = [
     ClientUIService,
     ClientWaypointsService,
 ];
+export const CLIENT_EAGER_PROVIDERS = [
+    UI
+];
 export async function bootstrap(_class, options = {}) {
-    return bootstrapWithProviders(_class, CLIENT_PROVIDERS, options, DecorationType.CLIENT, (key, index) => Cfx.Client.GetResourceMetadata(Cfx.Client.GetCurrentResourceName(), key, index), (resourceName) => Cfx.exports[resourceName]);
+    return bootstrapWithProviders(_class, CLIENT_PROVIDERS, options, DecorationType.CLIENT, (key, index) => Cfx.Client.GetResourceMetadata(Cfx.Client.GetCurrentResourceName(), key, index), (resourceName) => Cfx.exports[resourceName], CLIENT_EAGER_PROVIDERS);
 }
 export * from './services';
 export * from '@armoury/fivem-framework-common';

package/dist/esm/client/services/index.js

@@ -10,3 +10,4 @@ export * from './client-translate.service';
 export * from './client-vehicles.service';
 export * from './client-ui.service';
 export * from './client-waypoints.service';
+export * from './ui';

package/dist/esm/client/services/ui/index.js

@@ -0,0 +1 @@
+export * from './ui';

package/dist/esm/client/services/ui/ui.js

@@ -0,0 +1,40 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var UI_1;
+import { Resource, ResourceRef } from '@armoury/fivem-framework-common';
+import { Injectable } from 'injection-js';
+let UI = UI_1 = class UI {
+    constructor(armouryRef) {
+        UI_1.armouryRef = armouryRef;
+    }
+    static sendMessage(message) {
+        if (!isUIMessage(message)) {
+            console.error('Couldn\'t send UI message: Message doesn\'t respect a valid format.', 'Message:', message);
+            return;
+        }
+        this.armouryRef.instance.sendUIMessage(message);
+    }
+};
+UI = UI_1 = __decorate([
+    Injectable(),
+    __param(0, Resource('armoury')),
+    __metadata("design:paramtypes", [ResourceRef])
+], UI);
+export { UI };
+function isUIMessage(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        !Array.isArray(value) &&
+        "type" in value &&
+        typeof value.type === "string");
+}

package/dist/types/client/index.d.ts

@@ -1,9 +1,10 @@
 /// <reference path="../ambient.declarations.d.ts" />
 import 'reflect-metadata';
 import { Provider } from 'injection-js';
-import { ClientActionPointsService, ClientBlipsService, ClientCheckpointsService, ClientMarkersService, ClientPedsService, ClientSessionService, ClientTicksService, ClientUIService, ClientVehiclesService, ClientWaypointsService, ClientHudService } from './services';
+import { ClientActionPointsService, ClientBlipsService, ClientCheckpointsService, ClientMarkersService, ClientPedsService, ClientSessionService, ClientTicksService, ClientUIService, ClientVehiclesService, ClientWaypointsService, ClientHudService, UI } from './services';
 import { BootstrapOptions } from '@armoury/fivem-framework-common';
 export declare const CLIENT_PROVIDERS: (typeof ClientTicksService | typeof ClientActionPointsService | typeof ClientBlipsService | typeof ClientCheckpointsService | typeof ClientHudService | typeof ClientMarkersService | typeof ClientPedsService | typeof ClientSessionService | typeof ClientVehiclesService | typeof ClientUIService | typeof ClientWaypointsService)[];
+export declare const CLIENT_EAGER_PROVIDERS: (typeof UI)[];
 export declare function bootstrap<T extends {
     new (...args: any[]): any;
 } & Provider>(_class: T, options?: BootstrapOptions): Promise<InstanceType<T>>;

package/dist/types/client/services/index.d.ts

@@ -10,3 +10,4 @@ export * from './client-translate.service';
 export * from './client-vehicles.service';
 export * from './client-ui.service';
 export * from './client-waypoints.service';
+export * from './ui';

package/dist/types/client/services/ui/index.d.ts

@@ -0,0 +1 @@
+export * from './ui';

package/dist/types/client/services/ui/ui.d.ts

@@ -0,0 +1,11 @@
+import { ResourceRef } from '@armoury/fivem-framework-common';
+export declare class UI {
+    private static armouryRef;
+    constructor(armouryRef: ResourceRef);
+    static sendMessage(message: UIMessage): void;
+}
+type UIMessage = {
+    type: string;
+    [key: string]: unknown;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armoury/fivem-framework-client",
-  "version": "1.0.37",
+  "version": "1.0.38",
   "description": "Client APIs for the Armoury FiveM framework",
   "main": "dist/cjs/client/index.js",
   "module": "dist/esm/client/index.js",
@@ -25,7 +25,7 @@
     "rxjs": "^7.8.1"
   },
   "peerDependencies": {
-    "@armoury/fivem-framework-common": "1.0.37"
+    "@armoury/fivem-framework-common": "1.0.38"
   },
   "publishConfig": {
     "access": "public"