This commit introduces native operating system file dialogs in the desktop application replacing the existing web-based dialogs. It lays the foundation for future enhancements such as: - Providing error messages when saving or executing files, addressing #264. - Creating system restore points, addressing #50. Documentation updates: - Update `desktop-vs-web-features.md` with added functionality. - Update `README.md` with security feature highlights. - Update home page documentation to emphasize security features. Other supporting changes include: - Integrate IPC communication channels for secure Electron dialog API interactions. - Refactor `IpcRegistration` for more type-safety and simplicity. - Introduce a Vue hook to encapsulate dialog functionality. - Improve errors during IPC registration for easier troubleshooting. - Move `ClientLoggerFactory` for consistency in hooks organization and remove `LoggerFactory` interface for simplicity. - Add tests for the save file dialog in the browser context. - Add `Blob` polyfill in tests to compensate for the missing `blob.text()` function in `jsdom` (see jsdom/jsdom#2555). Improve environment detection logic: - Treat test environment as browser environments to correctly activate features based on the environment. This resolves issues where the environment is misidentified as desktop, but Electron preloader APIs are missing. - Rename `isDesktop` environment identification variable to `isRunningAsDesktopApplication` for better clarity and to avoid confusion with desktop environments in web/browser/test environments. - Simplify `BrowserRuntimeEnvironment` to consistently detect non-desktop application environments. - Improve environment detection for Electron main process (electron/electron#2288).
91 lines
3.6 KiB
TypeScript
91 lines
3.6 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/Log/UseLogger';
|
|
import type { useCodeRunner } from './components/Shared/Hooks/UseCodeRunner';
|
|
import type { useDialog } from './components/Shared/Hooks/Dialog/UseDialog';
|
|
|
|
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'),
|
|
useCodeRunner: defineTransientKey<ReturnType<typeof useCodeRunner>>('useCodeRunner'),
|
|
useDialog: defineTransientKey<ReturnType<typeof useDialog>>('useDialog'),
|
|
};
|
|
|
|
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;
|
|
}
|