@armoury/fivem-framework-common 1.0.12 → 1.0.13

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

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = Config;
+exports.createConfigProviders = createConfigProviders;
+exports.parseConfigValue = parseConfigValue;
+const injection_js_1 = require("injection-js");
+const luaparse_1 = require("luaparse");
+const CONFIG_PARAMETERS_METADATA = 'arm_config_parameters';
+function Config(key, index = 0) {
+    if (!key.trim()) {
+        throw new Error('Config metadata key must not be empty.');
+    }
+    if (!Number.isInteger(index) || index < 0) {
+        throw new Error('Config metadata index must be a non-negative integer.');
+    }
+    const token = new injection_js_1.InjectionToken(`Config(${key}, ${index})`);
+    const inject = (0, injection_js_1.Inject)(token);
+    return (target, propertyKey, parameterIndex) => {
+        var _a;
+        if (propertyKey !== undefined) {
+            throw new Error('Config can only decorate constructor parameters.');
+        }
+        inject(target, propertyKey, parameterIndex);
+        const bindings = (_a = Reflect.getOwnMetadata(CONFIG_PARAMETERS_METADATA, target)) !== null && _a !== void 0 ? _a : [];
+        const binding = { token, key, index };
+        Reflect.defineMetadata(CONFIG_PARAMETERS_METADATA, [...bindings, binding], target);
+    };
+}
+function createConfigProviders(targets, readValue) {
+    var _a;
+    const bindings = new Map();
+    for (const target of targets) {
+        let constructor = target;
+        while (constructor && constructor !== Function.prototype) {
+            const constructorBindings = (_a = Reflect.getOwnMetadata(CONFIG_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, key, index }) => ({
+        provide: token,
+        useFactory: () => {
+            const value = readValue(key, index);
+            if (value === null || value === undefined) {
+                throw new Error(`Missing resource metadata '${key}' at index ${index}.`);
+            }
+            return parseConfigValue(value, key);
+        },
+    }));
+}
+function parseConfigValue(value, metadataKey) {
+    let expression = value.trim();
+    const metadataCallPrefix = new RegExp(`^${escapeRegExp(metadataKey)}\\s+`);
+    expression = expression.replace(metadataCallPrefix, '');
+    if (expression.startsWith('{') || expression.startsWith('[')) {
+        try {
+            return JSON.parse(expression);
+        }
+        catch (_a) {
+            // Resource manifest tables use Lua syntax rather than JSON.
+        }
+    }
+    else if (!expression.startsWith('return')) {
+        return value;
+    }
+    const chunk = (0, luaparse_1.parse)(expression.startsWith('return') ? expression : `return ${expression}`, {
+        luaVersion: '5.3',
+    });
+    const statement = chunk.body[0];
+    if (chunk.body.length !== 1 || statement.type !== 'ReturnStatement' || statement.arguments.length !== 1) {
+        throw new Error(`Resource metadata '${metadataKey}' must contain a single table value.`);
+    }
+    return convertLuaExpression(statement.arguments[0], metadataKey);
+}
+function convertLuaExpression(expression, metadataKey) {
+    switch (expression.type) {
+        case 'TableConstructorExpression':
+            return convertLuaTable(expression, metadataKey);
+        case 'StringLiteral':
+        case 'NumericLiteral':
+        case 'BooleanLiteral':
+        case 'NilLiteral':
+            return expression.value;
+        case 'UnaryExpression':
+            if (expression.operator === '-' && expression.argument.type === 'NumericLiteral') {
+                return -expression.argument.value;
+            }
+            break;
+    }
+    throw new Error(`Resource metadata '${metadataKey}' contains an unsupported Lua expression.`);
+}
+function convertLuaTable(table, metadataKey) {
+    if (table.fields.every((field) => field.type === 'TableValue')) {
+        return table.fields.map((field) => convertLuaExpression(field.value, metadataKey));
+    }
+    const result = {};
+    let nextArrayIndex = 1;
+    for (const field of table.fields) {
+        let key;
+        let value;
+        if (field.type === 'TableKeyString') {
+            key = field.key.name;
+            value = field.value;
+        }
+        else if (field.type === 'TableKey') {
+            const parsedKey = convertLuaExpression(field.key, metadataKey);
+            if (typeof parsedKey !== 'string' && typeof parsedKey !== 'number') {
+                throw new Error(`Resource metadata '${metadataKey}' has an unsupported table key.`);
+            }
+            key = String(parsedKey);
+            value = field.value;
+        }
+        else {
+            key = String(nextArrayIndex++);
+            value = field.value;
+        }
+        Object.defineProperty(result, key, {
+            value: convertLuaExpression(value, metadataKey),
+            enumerable: true,
+            configurable: true,
+            writable: true,
+        });
+    }
+    return result;
+}
+function escapeRegExp(value) {
+    return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}

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.DecorationType = exports.Decorate = void 0;
+exports.APP_INITIALIZER = exports.Config = exports.DecorationType = exports.Decorate = void 0;
 exports.bootstrapWithProviders = bootstrapWithProviders;
 require("reflect-metadata");
 const injection_js_1 = require("injection-js");
@@ -26,14 +26,39 @@ Object.defineProperty(exports, "Decorate", { enumerable: true, get: function ()
 Object.defineProperty(exports, "DecorationType", { enumerable: true, get: function () { return decorator_utils_1.DecorationType; } });
 __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; } });
 const decorator_utils_2 = require("../decorators/decorator.utils");
+const config_decorator_2 = require("./config.decorator");
 exports.APP_INITIALIZER = new injection_js_1.InjectionToken('APP_INITIALIZER');
-async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = decorator_utils_2.DecorationType.SERVER) {
+function getProviderClasses(providers) {
+    const classes = [];
+    for (const provider of providers) {
+        if (Array.isArray(provider)) {
+            classes.push(...getProviderClasses(provider));
+            continue;
+        }
+        if (typeof provider === 'function') {
+            classes.push(provider);
+            continue;
+        }
+        if (provider && typeof provider === 'object' && 'useClass' in provider) {
+            classes.push(provider.useClass);
+        }
+    }
+    return classes;
+}
+async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = decorator_utils_2.DecorationType.SERVER, readConfigValue) {
     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 providers = [
+        ...((_b = options.providers) !== null && _b !== void 0 ? _b : []),
+        ...eagerProviders,
+    ];
+    const configTargets = [entryPoint, ...getProviderClasses(parentProviders), ...getProviderClasses(providers)];
+    const configProviders = (0, config_decorator_2.createConfigProviders)(configTargets, readConfigValue);
     const parentInjector = injection_js_1.ReflectiveInjector.resolveAndCreate(parentProviders);
-    const injector = injection_js_1.ReflectiveInjector.resolveAndCreate([...providers, entryPoint], parentInjector);
+    const injector = injection_js_1.ReflectiveInjector.resolveAndCreate([...configProviders, ...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));

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

@@ -0,0 +1,123 @@
+import { Inject, InjectionToken } from 'injection-js';
+import { parse as parseLua } from 'luaparse';
+const CONFIG_PARAMETERS_METADATA = 'arm_config_parameters';
+export function Config(key, index = 0) {
+    if (!key.trim()) {
+        throw new Error('Config metadata key must not be empty.');
+    }
+    if (!Number.isInteger(index) || index < 0) {
+        throw new Error('Config metadata index must be a non-negative integer.');
+    }
+    const token = new InjectionToken(`Config(${key}, ${index})`);
+    const inject = Inject(token);
+    return (target, propertyKey, parameterIndex) => {
+        var _a;
+        if (propertyKey !== undefined) {
+            throw new Error('Config can only decorate constructor parameters.');
+        }
+        inject(target, propertyKey, parameterIndex);
+        const bindings = (_a = Reflect.getOwnMetadata(CONFIG_PARAMETERS_METADATA, target)) !== null && _a !== void 0 ? _a : [];
+        const binding = { token, key, index };
+        Reflect.defineMetadata(CONFIG_PARAMETERS_METADATA, [...bindings, binding], target);
+    };
+}
+export function createConfigProviders(targets, readValue) {
+    var _a;
+    const bindings = new Map();
+    for (const target of targets) {
+        let constructor = target;
+        while (constructor && constructor !== Function.prototype) {
+            const constructorBindings = (_a = Reflect.getOwnMetadata(CONFIG_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, key, index }) => ({
+        provide: token,
+        useFactory: () => {
+            const value = readValue(key, index);
+            if (value === null || value === undefined) {
+                throw new Error(`Missing resource metadata '${key}' at index ${index}.`);
+            }
+            return parseConfigValue(value, key);
+        },
+    }));
+}
+export function parseConfigValue(value, metadataKey) {
+    let expression = value.trim();
+    const metadataCallPrefix = new RegExp(`^${escapeRegExp(metadataKey)}\\s+`);
+    expression = expression.replace(metadataCallPrefix, '');
+    if (expression.startsWith('{') || expression.startsWith('[')) {
+        try {
+            return JSON.parse(expression);
+        }
+        catch (_a) {
+            // Resource manifest tables use Lua syntax rather than JSON.
+        }
+    }
+    else if (!expression.startsWith('return')) {
+        return value;
+    }
+    const chunk = parseLua(expression.startsWith('return') ? expression : `return ${expression}`, {
+        luaVersion: '5.3',
+    });
+    const statement = chunk.body[0];
+    if (chunk.body.length !== 1 || statement.type !== 'ReturnStatement' || statement.arguments.length !== 1) {
+        throw new Error(`Resource metadata '${metadataKey}' must contain a single table value.`);
+    }
+    return convertLuaExpression(statement.arguments[0], metadataKey);
+}
+function convertLuaExpression(expression, metadataKey) {
+    switch (expression.type) {
+        case 'TableConstructorExpression':
+            return convertLuaTable(expression, metadataKey);
+        case 'StringLiteral':
+        case 'NumericLiteral':
+        case 'BooleanLiteral':
+        case 'NilLiteral':
+            return expression.value;
+        case 'UnaryExpression':
+            if (expression.operator === '-' && expression.argument.type === 'NumericLiteral') {
+                return -expression.argument.value;
+            }
+            break;
+    }
+    throw new Error(`Resource metadata '${metadataKey}' contains an unsupported Lua expression.`);
+}
+function convertLuaTable(table, metadataKey) {
+    if (table.fields.every((field) => field.type === 'TableValue')) {
+        return table.fields.map((field) => convertLuaExpression(field.value, metadataKey));
+    }
+    const result = {};
+    let nextArrayIndex = 1;
+    for (const field of table.fields) {
+        let key;
+        let value;
+        if (field.type === 'TableKeyString') {
+            key = field.key.name;
+            value = field.value;
+        }
+        else if (field.type === 'TableKey') {
+            const parsedKey = convertLuaExpression(field.key, metadataKey);
+            if (typeof parsedKey !== 'string' && typeof parsedKey !== 'number') {
+                throw new Error(`Resource metadata '${metadataKey}' has an unsupported table key.`);
+            }
+            key = String(parsedKey);
+            value = field.value;
+        }
+        else {
+            key = String(nextArrayIndex++);
+            value = field.value;
+        }
+        Object.defineProperty(result, key, {
+            value: convertLuaExpression(value, metadataKey),
+            enumerable: true,
+            configurable: true,
+            writable: true,
+        });
+    }
+    return result;
+}
+function escapeRegExp(value) {
+    return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}

package/dist/esm/common/index.js

@@ -6,14 +6,38 @@ export * from '../decorators';
 export { Decorate, DecorationType } from '../decorators/decorator.utils';
 export * from '../utils';
 export * from '../utils/utils';
+export { Config } from './config.decorator';
 import { Decorate, DecorationType } from '../decorators/decorator.utils';
+import { createConfigProviders } from './config.decorator';
 export const APP_INITIALIZER = new InjectionToken('APP_INITIALIZER');
-export async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = DecorationType.SERVER) {
+function getProviderClasses(providers) {
+    const classes = [];
+    for (const provider of providers) {
+        if (Array.isArray(provider)) {
+            classes.push(...getProviderClasses(provider));
+            continue;
+        }
+        if (typeof provider === 'function') {
+            classes.push(provider);
+            continue;
+        }
+        if (provider && typeof provider === 'object' && 'useClass' in provider) {
+            classes.push(provider.useClass);
+        }
+    }
+    return classes;
+}
+export async function bootstrapWithProviders(entryPoint, parentProviders, options = {}, decorationType = DecorationType.SERVER, readConfigValue) {
     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 providers = [
+        ...((_b = options.providers) !== null && _b !== void 0 ? _b : []),
+        ...eagerProviders,
+    ];
+    const configTargets = [entryPoint, ...getProviderClasses(parentProviders), ...getProviderClasses(providers)];
+    const configProviders = createConfigProviders(configTargets, readConfigValue);
     const parentInjector = ReflectiveInjector.resolveAndCreate(parentProviders);
-    const injector = ReflectiveInjector.resolveAndCreate([...providers, entryPoint], parentInjector);
+    const injector = ReflectiveInjector.resolveAndCreate([...configProviders, ...providers, entryPoint], parentInjector);
     const instance = injector.get(entryPoint);
     Decorate(instance, entryPoint.prototype, [...parentProviders, ...providers], decorationType);
     eagerProviders.forEach((provider) => injector.get(provider));

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

@@ -0,0 +1,5 @@
+import { Provider } from 'injection-js';
+export type ConfigValueReader = (key: string, index: number) => string | null | undefined;
+export declare function Config<T = unknown>(key: string, index?: number): ParameterDecorator;
+export declare function createConfigProviders(targets: Function[], readValue: ConfigValueReader): Provider[];
+export declare function parseConfigValue(value: string, metadataKey: string): unknown;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armoury/fivem-framework-common",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "Shared APIs for the Armoury FiveM framework",
   "main": "dist/cjs/common/index.js",
   "module": "dist/esm/common/index.js",
@@ -12,7 +12,9 @@
       "require": "./dist/cjs/common/index.js"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:types",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +23,10 @@
   },
   "dependencies": {
     "injection-js": "^2.4.0",
+    "luaparse": "^0.3.1",
     "reflect-metadata": "^0.2.1"
   },
   "publishConfig": {
     "access": "public"
   }
-}
+}