zumito-framework 1.23.3 → 1.24.0

package/dist/definitions/config/moduleHelpers.d.ts

@@ -0,0 +1,32 @@
+import { ZumitoFramework } from '../../ZumitoFramework.js';
+import type { ModuleEntry } from '../settings/FrameworkSettings.js';
+/**
+ * Creates a type-safe factory function that returns a `ModuleEntry`.
+ * Reads the module name from the nearest `package.json` by walking up
+ * from the caller's location.
+ *
+ * @example
+ * ```ts
+ * // admin/index.ts
+ * export const adminModule = createModuleEntry<AdminConfig>(import.meta.url);
+ *
+ * // Consumer's zumito.config.ts
+ * adminModule({ colors: { primary: '#ff0000' } })
+ * ```
+ */
+export declare function createModuleEntry<T = Record<string, any>>(metaUrl: string): (config?: T) => ModuleEntry;
+/**
+ * Retrieves the module-specific configuration from the framework settings
+ * by matching the module's package name against the `modules` array.
+ *
+ * Modules that are registered as plain strings in the `modules` array
+ * (without config) will return an empty object.
+ *
+ * @example
+ * ```ts
+ * import { getModuleConfig } from 'zumito-framework';
+ *
+ * const config = getModuleConfig<MyConfig>(framework, import.meta.url);
+ * ```
+ */
+export declare function getModuleConfig<T = Record<string, any>>(framework: ZumitoFramework | undefined, metaUrl: string): T;

package/dist/definitions/config/moduleHelpers.js

@@ -0,0 +1,71 @@
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+import { dirname, resolve } from 'path';
+import { existsSync } from 'fs';
+function findPackageJson(startPath) {
+    let dir = startPath;
+    for (let i = 0; i < 10; i++) {
+        const candidate = resolve(dir, 'package.json');
+        if (existsSync(candidate))
+            return candidate;
+        const parent = resolve(dir, '..');
+        if (parent === dir)
+            break;
+        dir = parent;
+    }
+    return null;
+}
+function readModuleName(metaUrl) {
+    const filePath = fileURLToPath(metaUrl);
+    const callerDir = dirname(filePath);
+    const pkgPath = findPackageJson(callerDir);
+    if (!pkgPath)
+        return null;
+    const require = createRequire(pkgPath);
+    return require(pkgPath)?.name ?? null;
+}
+/**
+ * Creates a type-safe factory function that returns a `ModuleEntry`.
+ * Reads the module name from the nearest `package.json` by walking up
+ * from the caller's location.
+ *
+ * @example
+ * ```ts
+ * // admin/index.ts
+ * export const adminModule = createModuleEntry<AdminConfig>(import.meta.url);
+ *
+ * // Consumer's zumito.config.ts
+ * adminModule({ colors: { primary: '#ff0000' } })
+ * ```
+ */
+export function createModuleEntry(metaUrl) {
+    const name = readModuleName(metaUrl);
+    if (!name) {
+        throw new Error(`createModuleEntry: could not read 'name' from package.json near ${metaUrl}`);
+    }
+    return (config) => ({ name, config });
+}
+/**
+ * Retrieves the module-specific configuration from the framework settings
+ * by matching the module's package name against the `modules` array.
+ *
+ * Modules that are registered as plain strings in the `modules` array
+ * (without config) will return an empty object.
+ *
+ * @example
+ * ```ts
+ * import { getModuleConfig } from 'zumito-framework';
+ *
+ * const config = getModuleConfig<MyConfig>(framework, import.meta.url);
+ * ```
+ */
+export function getModuleConfig(framework, metaUrl) {
+    if (!framework)
+        return {};
+    const name = readModuleName(metaUrl);
+    if (!name)
+        return {};
+    const modules = framework.settings?.modules ?? [];
+    const entry = modules.find((m) => typeof m !== 'string' && m.name === name);
+    return (entry?.config ?? {});
+}

package/dist/index.d.ts

@@ -42,6 +42,7 @@ export { CommandBinds } from './definitions/commands/CommandBinds.js';
 export { Injectable } from './definitions/decorators/Injectable.decorator.js';
 export { LauncherConfig } from './definitions/config/LauncherConfig.js';
 export { defineConfig } from './definitions/config/defineConfig.js';
+export { createModuleEntry, getModuleConfig } from './definitions/config/moduleHelpers.js';
 export type { ModuleEntry } from './definitions/settings/FrameworkSettings.js';
 export { ModuleParameters } from './definitions/parameters/ModuleParameters.js';
 export { ZumitoFramework, FrameworkSettings, Command, Module, ModuleDeclaration, ModuleRequeriments, CommandParameters, CommandArguments, FrameworkEvent, Translation, TranslationManager, ApiResponse, SelectMenuParameters, CommandType, CommandArgDefinition, CommandChoiceDefinition, ButtonPressed, ButtonPressedParams, TextFormatter, EmojiFallback, DatabaseConfigLoader, PresenceDataRule, RuledPresenceData, StatusManagerOptions, discord, EventParameters, ServiceContainer, GuildDataGetter, SlashCommandRefresher, CommandParser, ErrorHandler, ErrorType, Route, RouteMethod, InteractionHandler, CommandManager, InviteUrlGenerator, PrefixResolver, CommandExecutionChecker, DatabaseManager, };

package/dist/index.js

@@ -29,6 +29,7 @@ import { DatabaseManager } from 'zumito-db';
 export { Collection, Field, HasMany, BelongsTo, HasOne, Migration, Repository, QueryBuilder } from 'zumito-db';
 export { Injectable } from './definitions/decorators/Injectable.decorator.js';
 export { defineConfig } from './definitions/config/defineConfig.js';
+export { createModuleEntry, getModuleConfig } from './definitions/config/moduleHelpers.js';
 ServiceContainer.addService(TextFormatter, []);
 ServiceContainer.addService(EmojiFallback, [discord.Client.name, TranslationManager.name]);
 ServiceContainer.addService(GuildDataGetter, [ZumitoFramework.name]);

package/dist/services/managers/CommandManager.js

@@ -42,6 +42,8 @@ export class CommandManager {
         if (!filePath.endsWith('.js') && !filePath.endsWith('.ts')) {
             return;
         }
+        if (filePath.endsWith('.d.ts'))
+            return;
         const counter = (this.importCounters.get(filePath) || 0) + 1;
         this.importCounters.set(filePath, counter);
         const baseName = path.basename(filePath).split('.').slice(0, -1).join('.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.23.3",
+  "version": "1.24.0",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",