- Migrate to `electron-log` v5.X.X, centralizing log files to adhere to best-practices. - Add critical event logging in the log file. - Replace `ElectronLog` type with `LogFunctions` for better abstraction. - Unify log handling in `desktop-runtime-error` by removing `renderer.log` due to `electron-log` v5 changes. - Update and extend logger interfaces, removing 'I' prefix and adding common log levels to abstract `electron-log` completely. - Move logger interfaces to the application layer as it's cross-cutting concern, meanwhile keeping the implementations in the infrastructure layer. - Introduce `useLogger` hook for easier logging in Vue components. - Simplify `WindowVariables` by removing nullable properties. - Improve documentation to clearly differentiate between desktop and web versions, outlining specific features of each.
87 lines
3.3 KiB
TypeScript
87 lines
3.3 KiB
TypeScript
import { inject, type InjectionKey } from 'vue';
|
|
import type { useCollectionState } from '@/presentation/components/Shared/Hooks/UseCollectionState';
|
|
import type { useApplication } from '@/presentation/components/Shared/Hooks/UseApplication';
|
|
import type { useRuntimeEnvironment } from '@/presentation/components/Shared/Hooks/UseRuntimeEnvironment';
|
|
import type { useClipboard } from '@/presentation/components/Shared/Hooks/Clipboard/UseClipboard';
|
|
import type { useCurrentCode } from '@/presentation/components/Shared/Hooks/UseCurrentCode';
|
|
import type { useAutoUnsubscribedEvents } from '@/presentation/components/Shared/Hooks/UseAutoUnsubscribedEvents';
|
|
import type { useUserSelectionState } from '@/presentation/components/Shared/Hooks/UseUserSelectionState';
|
|
import type { useLogger } from '@/presentation/components/Shared/Hooks/UseLogger';
|
|
|
|
export const InjectionKeys = {
|
|
useCollectionState: defineTransientKey<ReturnType<typeof useCollectionState>>('useCollectionState'),
|
|
useApplication: defineSingletonKey<ReturnType<typeof useApplication>>('useApplication'),
|
|
useRuntimeEnvironment: defineSingletonKey<ReturnType<typeof useRuntimeEnvironment>>('useRuntimeEnvironment'),
|
|
useAutoUnsubscribedEvents: defineTransientKey<ReturnType<typeof useAutoUnsubscribedEvents>>('useAutoUnsubscribedEvents'),
|
|
useClipboard: defineTransientKey<ReturnType<typeof useClipboard>>('useClipboard'),
|
|
useCurrentCode: defineTransientKey<ReturnType<typeof useCurrentCode>>('useCurrentCode'),
|
|
useUserSelectionState: defineTransientKey<ReturnType<typeof useUserSelectionState>>('useUserSelectionState'),
|
|
useLogger: defineTransientKey<ReturnType<typeof useLogger>>('useLogger'),
|
|
};
|
|
|
|
export interface InjectionKeyWithLifetime<T> {
|
|
readonly lifetime: InjectionKeyLifetime;
|
|
readonly key: InjectionKey<T> & symbol;
|
|
}
|
|
|
|
export interface SingletonKey<T> extends InjectionKeyWithLifetime<T> {
|
|
readonly lifetime: InjectionKeyLifetime.Singleton;
|
|
readonly key: InjectionKey<T> & symbol;
|
|
}
|
|
|
|
export interface TransientKey<T> extends InjectionKeyWithLifetime<() => T> {
|
|
readonly lifetime: InjectionKeyLifetime.Transient;
|
|
readonly key: InjectionKey<() => T> & symbol;
|
|
}
|
|
|
|
export type AnyLifetimeInjectionKey<T> = InjectionKeyWithLifetime<T> | TransientKey<T>;
|
|
|
|
export type InjectionKeySelector<T> = (keys: typeof InjectionKeys) => AnyLifetimeInjectionKey<T>;
|
|
|
|
export function injectKey<T>(
|
|
keySelector: InjectionKeySelector<T>,
|
|
vueInjector = inject,
|
|
): T {
|
|
const key = keySelector(InjectionKeys);
|
|
const injectedValue = injectRequired(key.key, vueInjector);
|
|
if (key.lifetime === InjectionKeyLifetime.Transient) {
|
|
const factory = injectedValue as () => T;
|
|
const value = factory();
|
|
return value;
|
|
}
|
|
|
|
return injectedValue as T;
|
|
}
|
|
|
|
export enum InjectionKeyLifetime {
|
|
Singleton,
|
|
Transient,
|
|
}
|
|
|
|
function defineSingletonKey<T>(key: string): SingletonKey<T> {
|
|
return {
|
|
lifetime: InjectionKeyLifetime.Singleton,
|
|
key: Symbol(key),
|
|
};
|
|
}
|
|
|
|
function defineTransientKey<T>(key: string): TransientKey<T> {
|
|
return {
|
|
lifetime: InjectionKeyLifetime.Transient,
|
|
key: Symbol(key),
|
|
};
|
|
}
|
|
|
|
function injectRequired<T>(
|
|
key: InjectionKey<T>,
|
|
vueInjector = inject,
|
|
): T {
|
|
const injectedValue = vueInjector(key);
|
|
|
|
if (injectedValue === undefined) {
|
|
throw new Error(`Failed to inject value for key: ${key.description}`);
|
|
}
|
|
|
|
return injectedValue;
|
|
}
|