@armoury/fivem-framework-common 1.0.14 → 1.0.16

package/dist/cjs/common/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.APP_INITIALIZER = exports.Config = exports.DecorationType = exports.Decorate = void 0;
+exports.APP_INITIALIZER = exports.ResourceRef = exports.Resource = exports.Config = exports.DecorationType = exports.Decorate = void 0;
 exports.bootstrapWithProviders = bootstrapWithProviders;
 require("reflect-metadata");
 const injection_js_1 = require("injection-js");
@@ -28,9 +28,39 @@ __exportStar(require("../utils"), exports);
 __exportStar(require("../utils/utils"), exports);
 var config_decorator_1 = require("./config.decorator");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_decorator_1.Config; } });
+var resource_decorator_1 = require("./resource.decorator");
+Object.defineProperty(exports, "Resource", { enumerable: true, get: function () { return resource_decorator_1.Resource; } });
+Object.defineProperty(exports, "ResourceRef", { enumerable: true, get: function () { return resource_decorator_1.ResourceRef; } });
 const decorator_utils_2 = require("../decorators/decorator.utils");
 const config_decorator_2 = require("./config.decorator");
+const resource_decorator_2 = require("./resource.decorator");
 exports.APP_INITIALIZER = new injection_js_1.InjectionToken('APP_INITIALIZER');
+function flattenProviders(providers) {
+    const flattened = [];
+    for (const provider of providers) {
+        if (Array.isArray(provider)) {
+            flattened.push(...flattenProviders(provider));
+        }
+        else {
+            flattened.push(provider);
+        }
+    }
+    return flattened;
+}
+function getProviderToken(provider) {
+    if (typeof provider === 'function') {
+        return provider;
+    }
+    if (provider && typeof provider === 'object' && 'provide' in provider) {
+        return provider.provide;
+    }
+    return undefined;
+}
+function getProviderTokens(providers) {
+    return flattenProviders(providers)
+        .map(getProviderToken)
+        .filter((token) => token !== undefined);
+}
 function getProviderClasses(providers) {
     const classes = [];
     for (const provider of providers) {
@@ -48,20 +78,40 @@ function getProviderClasses(providers) {
     }
     return classes;
 }
-async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = decorator_utils_2.DecorationType.SERVER, readConfigValue) {
+function hasProviderForToken(providers, token) {
+    for (const provider of providers) {
+        if (Array.isArray(provider)) {
+            if (hasProviderForToken(provider, token)) {
+                return true;
+            }
+            continue;
+        }
+        if (provider === token || (provider && typeof provider === 'object' && 'provide' in provider && provider.provide === token)) {
+            return true;
+        }
+    }
+    return false;
+}
+async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = decorator_utils_2.DecorationType.SERVER, readConfigValue, readResourceExports, defaultEagerProviders = []) {
     var _a, _b;
     const eagerProviders = (_a = options.eager) !== null && _a !== void 0 ? _a : [];
-    const providers = [
-        ...((_b = options.providers) !== null && _b !== void 0 ? _b : []),
-        ...eagerProviders,
-    ];
+    const optionProviders = (_b = options.providers) !== null && _b !== void 0 ? _b : [];
+    const platformDefaultProviders = flattenProviders(defaultEagerProviders);
+    const activeDefaultEagerProviders = platformDefaultProviders.filter((defaultProvider) => {
+        const token = getProviderToken(defaultProvider);
+        return token === undefined || !hasProviderForToken([...parentProviders, ...optionProviders], token);
+    });
+    const eagerRegistrations = eagerProviders.filter((eagerProvider) => !hasProviderForToken([...parentProviders, ...optionProviders], eagerProvider));
+    const providers = [...activeDefaultEagerProviders, ...optionProviders, ...eagerRegistrations];
+    const eagerTokens = [...new Set([...getProviderTokens(platformDefaultProviders), ...eagerProviders])];
     const configTargets = [entryPoint, ...getProviderClasses(parentProviders), ...getProviderClasses(providers)];
     const configProviders = (0, config_decorator_2.createConfigProviders)(configTargets, readConfigValue);
+    const resourceProviders = (0, resource_decorator_2.createResourceProviders)(configTargets, readResourceExports);
     const parentInjector = injection_js_1.ReflectiveInjector.resolveAndCreate(parentProviders);
-    const injector = injection_js_1.ReflectiveInjector.resolveAndCreate([...configProviders, ...providers, entryPoint], parentInjector);
+    const injector = injection_js_1.ReflectiveInjector.resolveAndCreate([...configProviders, ...resourceProviders, ...providers, entryPoint], parentInjector);
     const instance = injector.get(entryPoint);
     (0, decorator_utils_2.Decorate)(instance, entryPoint.prototype, [...parentProviders, ...providers], decorationType);
-    eagerProviders.forEach((provider) => injector.get(provider));
+    eagerTokens.forEach((token) => injector.get(token));
     const initializers = injector.get(exports.APP_INITIALIZER, []);
     await Promise.all(initializers.map((initializer) => initializer()));
     return instance;

package/dist/cjs/common/resource.decorator.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceRef = void 0;
+exports.Resource = Resource;
+exports.createResourceProviders = createResourceProviders;
+const injection_js_1 = require("injection-js");
+const RESOURCE_PARAMETERS_METADATA = 'arm_resource_parameters';
+class ResourceRef {
+    constructor(resourceName, readExports) {
+        this.resourceName = resourceName;
+        this.readExports = readExports;
+    }
+    get instance() {
+        const resourceExports = this.readExports(this.resourceName);
+        if (resourceExports === null || resourceExports === undefined) {
+            throw new Error(`Resource '${this.resourceName}' is not available or exposes no exports.`);
+        }
+        return resourceExports;
+    }
+}
+exports.ResourceRef = ResourceRef;
+function Resource(resourceName) {
+    if (!resourceName.trim()) {
+        throw new Error('Resource name must not be empty.');
+    }
+    const token = new injection_js_1.InjectionToken(`Resource(${resourceName})`);
+    const inject = (0, injection_js_1.Inject)(token);
+    return (target, propertyKey, parameterIndex) => {
+        var _a;
+        if (propertyKey !== undefined) {
+            throw new Error('Resource can only decorate constructor parameters.');
+        }
+        inject(target, propertyKey, parameterIndex);
+        const bindings = (_a = Reflect.getOwnMetadata(RESOURCE_PARAMETERS_METADATA, target)) !== null && _a !== void 0 ? _a : [];
+        Reflect.defineMetadata(RESOURCE_PARAMETERS_METADATA, [...bindings, { token, resourceName }], target);
+    };
+}
+function createResourceProviders(targets, readExports) {
+    var _a;
+    const bindings = new Map();
+    for (const target of targets) {
+        let constructor = target;
+        while (constructor && constructor !== Function.prototype) {
+            const constructorBindings = (_a = Reflect.getOwnMetadata(RESOURCE_PARAMETERS_METADATA, constructor)) !== null && _a !== void 0 ? _a : [];
+            constructorBindings.forEach((binding) => bindings.set(binding.token, binding));
+            constructor = Object.getPrototypeOf(constructor);
+        }
+    }
+    return [...bindings.values()].map(({ token, resourceName }) => ({
+        provide: token,
+        useFactory: () => new ResourceRef(resourceName, readExports),
+    }));
+}

package/dist/esm/common/index.js

@@ -7,9 +7,37 @@ export { Decorate, DecorationType } from '../decorators/decorator.utils';
 export * from '../utils';
 export * from '../utils/utils';
 export { Config } from './config.decorator';
+export { Resource, ResourceRef } from './resource.decorator';
 import { Decorate, DecorationType } from '../decorators/decorator.utils';
 import { createConfigProviders } from './config.decorator';
+import { createResourceProviders } from './resource.decorator';
 export const APP_INITIALIZER = new InjectionToken('APP_INITIALIZER');
+function flattenProviders(providers) {
+    const flattened = [];
+    for (const provider of providers) {
+        if (Array.isArray(provider)) {
+            flattened.push(...flattenProviders(provider));
+        }
+        else {
+            flattened.push(provider);
+        }
+    }
+    return flattened;
+}
+function getProviderToken(provider) {
+    if (typeof provider === 'function') {
+        return provider;
+    }
+    if (provider && typeof provider === 'object' && 'provide' in provider) {
+        return provider.provide;
+    }
+    return undefined;
+}
+function getProviderTokens(providers) {
+    return flattenProviders(providers)
+        .map(getProviderToken)
+        .filter((token) => token !== undefined);
+}
 function getProviderClasses(providers) {
     const classes = [];
     for (const provider of providers) {
@@ -27,20 +55,40 @@ function getProviderClasses(providers) {
     }
     return classes;
 }
-export async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = DecorationType.SERVER, readConfigValue) {
+function hasProviderForToken(providers, token) {
+    for (const provider of providers) {
+        if (Array.isArray(provider)) {
+            if (hasProviderForToken(provider, token)) {
+                return true;
+            }
+            continue;
+        }
+        if (provider === token || (provider && typeof provider === 'object' && 'provide' in provider && provider.provide === token)) {
+            return true;
+        }
+    }
+    return false;
+}
+export async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = DecorationType.SERVER, readConfigValue, readResourceExports, defaultEagerProviders = []) {
     var _a, _b;
     const eagerProviders = (_a = options.eager) !== null && _a !== void 0 ? _a : [];
-    const providers = [
-        ...((_b = options.providers) !== null && _b !== void 0 ? _b : []),
-        ...eagerProviders,
-    ];
+    const optionProviders = (_b = options.providers) !== null && _b !== void 0 ? _b : [];
+    const platformDefaultProviders = flattenProviders(defaultEagerProviders);
+    const activeDefaultEagerProviders = platformDefaultProviders.filter((defaultProvider) => {
+        const token = getProviderToken(defaultProvider);
+        return token === undefined || !hasProviderForToken([...parentProviders, ...optionProviders], token);
+    });
+    const eagerRegistrations = eagerProviders.filter((eagerProvider) => !hasProviderForToken([...parentProviders, ...optionProviders], eagerProvider));
+    const providers = [...activeDefaultEagerProviders, ...optionProviders, ...eagerRegistrations];
+    const eagerTokens = [...new Set([...getProviderTokens(platformDefaultProviders), ...eagerProviders])];
     const configTargets = [entryPoint, ...getProviderClasses(parentProviders), ...getProviderClasses(providers)];
     const configProviders = createConfigProviders(configTargets, readConfigValue);
+    const resourceProviders = createResourceProviders(configTargets, readResourceExports);
     const parentInjector = ReflectiveInjector.resolveAndCreate(parentProviders);
-    const injector = ReflectiveInjector.resolveAndCreate([...configProviders, ...providers, entryPoint], parentInjector);
+    const injector = ReflectiveInjector.resolveAndCreate([...configProviders, ...resourceProviders, ...providers, entryPoint], parentInjector);
     const instance = injector.get(entryPoint);
     Decorate(instance, entryPoint.prototype, [...parentProviders, ...providers], decorationType);
-    eagerProviders.forEach((provider) => injector.get(provider));
+    eagerTokens.forEach((token) => injector.get(token));
     const initializers = injector.get(APP_INITIALIZER, []);
     await Promise.all(initializers.map((initializer) => initializer()));
     return instance;

package/dist/esm/common/resource.decorator.js

@@ -0,0 +1,47 @@
+import { Inject, InjectionToken } from 'injection-js';
+const RESOURCE_PARAMETERS_METADATA = 'arm_resource_parameters';
+export class ResourceRef {
+    constructor(resourceName, readExports) {
+        this.resourceName = resourceName;
+        this.readExports = readExports;
+    }
+    get instance() {
+        const resourceExports = this.readExports(this.resourceName);
+        if (resourceExports === null || resourceExports === undefined) {
+            throw new Error(`Resource '${this.resourceName}' is not available or exposes no exports.`);
+        }
+        return resourceExports;
+    }
+}
+export function Resource(resourceName) {
+    if (!resourceName.trim()) {
+        throw new Error('Resource name must not be empty.');
+    }
+    const token = new InjectionToken(`Resource(${resourceName})`);
+    const inject = Inject(token);
+    return (target, propertyKey, parameterIndex) => {
+        var _a;
+        if (propertyKey !== undefined) {
+            throw new Error('Resource can only decorate constructor parameters.');
+        }
+        inject(target, propertyKey, parameterIndex);
+        const bindings = (_a = Reflect.getOwnMetadata(RESOURCE_PARAMETERS_METADATA, target)) !== null && _a !== void 0 ? _a : [];
+        Reflect.defineMetadata(RESOURCE_PARAMETERS_METADATA, [...bindings, { token, resourceName }], target);
+    };
+}
+export function createResourceProviders(targets, readExports) {
+    var _a;
+    const bindings = new Map();
+    for (const target of targets) {
+        let constructor = target;
+        while (constructor && constructor !== Function.prototype) {
+            const constructorBindings = (_a = Reflect.getOwnMetadata(RESOURCE_PARAMETERS_METADATA, constructor)) !== null && _a !== void 0 ? _a : [];
+            constructorBindings.forEach((binding) => bindings.set(binding.token, binding));
+            constructor = Object.getPrototypeOf(constructor);
+        }
+    }
+    return [...bindings.values()].map(({ token, resourceName }) => ({
+        provide: token,
+        useFactory: () => new ResourceRef(resourceName, readExports),
+    }));
+}

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

@@ -6,8 +6,10 @@ export { Decorate, DecorationType } from '../decorators/decorator.utils';
 export * from '../utils';
 export * from '../utils/utils';
 export { Config } from './config.decorator';
+export { Resource, ResourceRef } from './resource.decorator';
 import { DecorationType } from '../decorators/decorator.utils';
 import { ConfigValueReader } from './config.decorator';
+import { ResourceExportsReader } from './resource.decorator';
 export type AppInitializer = () => void | Promise<void>;
 export declare const APP_INITIALIZER: InjectionToken<AppInitializer[]>;
 export interface BootstrapOptions {
@@ -18,4 +20,4 @@ export interface BootstrapOptions {
 }
 export declare function bootstrapWithProviders<T extends {
     new (...args: any[]): any;
-} & Provider>(entryPoint: T, parentProviders: Provider[], options: BootstrapOptions | undefined, decorationType: DecorationType | undefined, readConfigValue: ConfigValueReader): Promise<InstanceType<T>>;
+} & Provider>(entryPoint: T, parentProviders: Provider[], options: BootstrapOptions | undefined, decorationType: DecorationType | undefined, readConfigValue: ConfigValueReader, readResourceExports: ResourceExportsReader, defaultEagerProviders?: Provider[]): Promise<InstanceType<T>>;

package/dist/types/common/resource.decorator.d.ts

@@ -0,0 +1,10 @@
+import { Provider } from 'injection-js';
+export type ResourceExportsReader = (resourceName: string) => unknown;
+export declare class ResourceRef<T = Record<string, (...args: any[]) => any>> {
+    readonly resourceName: string;
+    private readonly readExports;
+    constructor(resourceName: string, readExports: ResourceExportsReader);
+    get instance(): T;
+}
+export declare function Resource<T = Record<string, (...args: any[]) => any>>(resourceName: string): ParameterDecorator;
+export declare function createResourceProviders(targets: Function[], readExports: ResourceExportsReader): Provider[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armoury/fivem-framework-common",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Shared APIs for the Armoury FiveM framework",
   "main": "dist/cjs/common/index.js",
   "module": "dist/esm/common/index.js",