Files
custum-hyprpanel/src/components/bar/customModules/module_container/helpers/label.ts
Jas Singh 8cf5806766 Minor: Refactor the code-base for better organization and compartmentalization. (#934)
* Clean up unused code

* Fix media player formatting issue for labels with new line characteres.

* Refactor the media player handlers into a class.

* More code cleanup and organize shared weather utils into distinct classes.

* Flatten some nesting.

* Move weather manager in dedicated class and build HTTP Utility class for Rest API calling.

* Remove logs

* Rebase master merge

* Reorg code (WIP)

* More reorg

* Delete utility scripts

* Reorg options

* Finish moving all options over

* Fix typescript issues

* Update options imports to default

* missed update

* Screw barrel files honestly, work of the devil.

* Only initialize power profiles if power-profiles-daemon is running.

* Fix window positioning and weather service naming

* style dir

* More organization

* Restructure types to be closer to their source

* Remove lib types and constants

* Update basic weather object to be saner with extensibility.

* Service updates

* Fix initialization strategy for services.

* Fix Config Manager to only emit changed objects and added missing temp converters.

* Update storage service to handle unit changes.

* Added cpu temp sensor auto-discovery

* Added missing JSDocs to services

* remove unused

* Migrate to network service.

* Fix network password issue.

* Move out password input into helper

* Rename password mask constant to be less double-negativey.

* Dropdown menu rename

* Added a component to edit JSON in the settings dialog (rough/WIP)

* Align settings

* Add and style JSON Editor.

* Adjust padding

* perf(shortcuts):  avoid unnecessary polling when shortcuts are disabled

Stops the recording poller when shortcuts are disabled, preventing redundant polling and reducing resource usage.

* Fix types and return value if shortcut not enabled.

* Move the swww daemon checking process outside of the wallpaper service into a dedicated deamon lifecyle processor.

* Add more string formatters and use title case for weather status (as it was).

* Fix startup errors.

* Rgba fix

* Remove zod from dependencies

---------

Co-authored-by: KernelDiego <gonzalezdiego.contact@gmail.com>
2025-05-26 19:45:11 -07:00

120 lines
4.2 KiB
TypeScript

import { isPrimitive } from 'src/lib/validation/types';
/**
* Generates a label based on module command output and a template configuration.
*
* @param moduleName - The name of the module (used for error reporting)
* @param commandOutput - The raw output from a module command, expected to be a JSON string or plain text
* @param labelConfig - A template string containing variables in the format {path.to.value}
* @returns A formatted label with template variables replaced with actual values
*
* @example
* // For a JSON command output: {"user": {"name": "Jim Halpert"}}
* // And labelConfig: "Hello, {user.name}!"
* // Returns: "Hello, Jim Halpert!"
*/
export function getLabel(moduleName: string, commandOutput: string, labelConfig: string): string {
const processedCommandOutput = tryParseJson(moduleName, commandOutput);
const regexForTemplateVariables = /\{([^{}]*)\}/g;
return labelConfig.replace(regexForTemplateVariables, (_, path) => {
return getValueForTemplateVariable(path, processedCommandOutput);
});
}
/**
* Extracts a value from command output based on a template variable path.
*
* @param templatePath - The dot-notation path to extract (e.g., "user.name")
* @param commandOutput - The processed command output (either a string or object)
* @returns The extracted value as a string, or empty string if not found
*/
function getValueForTemplateVariable(
templatePath: string,
commandOutput: string | Record<string, unknown>,
): string {
if (typeof commandOutput === 'string') {
return getTemplateValueForStringOutput(templatePath, commandOutput);
}
if (typeof commandOutput === 'object' && commandOutput !== null) {
return getTemplateValueForObjectOutput(templatePath, commandOutput);
}
return '';
}
/**
* Extracts a template value from string command output.
*
* @param templatePath - The path to extract value from
* @param commandOutput - The string command output
* @returns The entire string if path is empty, otherwise empty string
*/
function getTemplateValueForStringOutput(templatePath: string, commandOutput: string): string {
if (templatePath === '') {
return commandOutput;
}
return '';
}
/**
* Extracts a template value from object command output using dot notation.
*
* @param templatePath - The dot-notation path to extract (e.g., "user.name")
* @param commandOutput - The object representing parsed command output
* @returns The extracted value as a string, or empty string if path is invalid or value is not primitive
*/
function getTemplateValueForObjectOutput(
templatePath: string,
commandOutput: Record<string, unknown>,
): string {
const pathParts = templatePath.split('.');
function isRecord(value: unknown): value is Record<string, unknown> {
return value !== null && !Array.isArray(value) && typeof value === 'object';
}
try {
const result = pathParts.reduce<unknown>((acc, part) => {
if (!isRecord(acc)) {
throw new Error('Path unreachable');
}
return acc[part];
}, commandOutput);
return isPrimitive(result) && result !== undefined ? String(result) : '';
} catch {
return '';
}
}
/**
* Attempts to parse a JSON string, with fallback to the original string.
*
* @param moduleName - The name of the module (used for error reporting)
* @param commandOutput - The raw string output to parse as JSON
* @returns A parsed object if valid JSON and an object, otherwise the original string
*/
function tryParseJson(moduleName: string, commandOutput: string): string | Record<string, unknown> {
try {
if (typeof commandOutput !== 'string') {
console.error(
`Expected command output to be a string but found ${typeof commandOutput} for module: ${moduleName}`,
);
return '';
}
const parsedCommand = JSON.parse(commandOutput);
if (typeof parsedCommand === 'object' && parsedCommand !== null && !Array.isArray(parsedCommand)) {
return parsedCommand as Record<string, unknown>;
}
return commandOutput;
} catch {
return commandOutput;
}
}