mirror of
https://github.com/bitwarden/browser
synced 2025-12-12 22:33:35 +00:00
9c1e2ebd67
* Use typescript-strict-plugin to iteratively turn on strict * Add strict testing to pipeline Can be executed locally through either `npm run test:types` for full type checking including spec files, or `npx tsc-strict` for only tsconfig.json included files. * turn on strict for scripts directory * Use plugin for all tsconfigs in monorepo vscode is capable of executing tsc with plugins, but uses the most relevant tsconfig to do so. If the plugin is not a part of that config, it is skipped and developers get no feedback of strict compile time issues. These updates remedy that at the cost of slightly more complex removal of the plugin when the time comes. * remove plugin from configs that extend one that already has it * Update workspace settings to honor strict plugin * Apply strict-plugin to native message test runner * Update vscode workspace to use root tsc version * `./node_modules/.bin/update-strict-comments` 🤖 This is a one-time operation. All future files should adhere to strict type checking. * Add fixme to `ts-strict-ignore` comments * `update-strict-comments` 🤖 repeated for new merge files
73 lines
3.5 KiB
TypeScript
73 lines
3.5 KiB
TypeScript
// FIXME: Update this file to be type safe and remove this and next line
|
|
// @ts-strict-ignore
|
|
import { InjectionToken } from "@angular/core";
|
|
import { Observable, Subject } from "rxjs";
|
|
|
|
import { LogoutReason } from "@bitwarden/auth/common";
|
|
import { ClientType } from "@bitwarden/common/enums";
|
|
import { RegionConfig } from "@bitwarden/common/platform/abstractions/environment.service";
|
|
import {
|
|
AbstractStorageService,
|
|
ObservableStorageService,
|
|
} from "@bitwarden/common/platform/abstractions/storage.service";
|
|
import { Theme } from "@bitwarden/common/platform/enums";
|
|
import { StateFactory } from "@bitwarden/common/platform/factories/state-factory";
|
|
import { Message } from "@bitwarden/common/platform/messaging";
|
|
import { VaultTimeout } from "@bitwarden/common/types/vault-timeout.type";
|
|
|
|
declare const tag: unique symbol;
|
|
/**
|
|
* A (more) typesafe version of InjectionToken which will more strictly enforce the generic type parameter.
|
|
* @remarks The default angular implementation does not use the generic type to define the structure of the object,
|
|
* so the structural type system will not complain about a mismatch in the type parameter.
|
|
* This is solved by assigning T to an arbitrary private property.
|
|
*/
|
|
export class SafeInjectionToken<T> extends InjectionToken<T> {
|
|
private readonly [tag]: T;
|
|
}
|
|
|
|
export const WINDOW = new SafeInjectionToken<Window>("WINDOW");
|
|
export const OBSERVABLE_MEMORY_STORAGE = new SafeInjectionToken<
|
|
AbstractStorageService & ObservableStorageService
|
|
>("OBSERVABLE_MEMORY_STORAGE");
|
|
export const OBSERVABLE_DISK_STORAGE = new SafeInjectionToken<
|
|
AbstractStorageService & ObservableStorageService
|
|
>("OBSERVABLE_DISK_STORAGE");
|
|
export const OBSERVABLE_DISK_LOCAL_STORAGE = new SafeInjectionToken<
|
|
AbstractStorageService & ObservableStorageService
|
|
>("OBSERVABLE_DISK_LOCAL_STORAGE");
|
|
export const MEMORY_STORAGE = new SafeInjectionToken<AbstractStorageService>("MEMORY_STORAGE");
|
|
export const SECURE_STORAGE = new SafeInjectionToken<AbstractStorageService>("SECURE_STORAGE");
|
|
export const STATE_FACTORY = new SafeInjectionToken<StateFactory>("STATE_FACTORY");
|
|
export const LOGOUT_CALLBACK = new SafeInjectionToken<
|
|
(logoutReason: LogoutReason, userId?: string) => Promise<void>
|
|
>("LOGOUT_CALLBACK");
|
|
export const LOCKED_CALLBACK = new SafeInjectionToken<(userId?: string) => Promise<void>>(
|
|
"LOCKED_CALLBACK",
|
|
);
|
|
export const SUPPORTS_SECURE_STORAGE = new SafeInjectionToken<boolean>("SUPPORTS_SECURE_STORAGE");
|
|
export const LOCALES_DIRECTORY = new SafeInjectionToken<string>("LOCALES_DIRECTORY");
|
|
export const SYSTEM_LANGUAGE = new SafeInjectionToken<string>("SYSTEM_LANGUAGE");
|
|
export const LOG_MAC_FAILURES = new SafeInjectionToken<boolean>("LOG_MAC_FAILURES");
|
|
export const SYSTEM_THEME_OBSERVABLE = new SafeInjectionToken<Observable<Theme>>(
|
|
"SYSTEM_THEME_OBSERVABLE",
|
|
);
|
|
export const DEFAULT_VAULT_TIMEOUT = new SafeInjectionToken<VaultTimeout>("DEFAULT_VAULT_TIMEOUT");
|
|
export const INTRAPROCESS_MESSAGING_SUBJECT = new SafeInjectionToken<
|
|
Subject<Message<Record<string, unknown>>>
|
|
>("INTRAPROCESS_MESSAGING_SUBJECT");
|
|
export const CLIENT_TYPE = new SafeInjectionToken<ClientType>("CLIENT_TYPE");
|
|
|
|
export const REFRESH_ACCESS_TOKEN_ERROR_CALLBACK = new SafeInjectionToken<() => void>(
|
|
"REFRESH_ACCESS_TOKEN_ERROR_CALLBACK",
|
|
);
|
|
|
|
/**
|
|
* Injection token for injecting the NodeJS process.env additional regions into services.
|
|
* Using an injection token allows services to be tested without needing to
|
|
* mock the process.env.
|
|
*/
|
|
export const ENV_ADDITIONAL_REGIONS = new SafeInjectionToken<RegionConfig[]>(
|
|
"ENV_ADDITIONAL_REGIONS",
|
|
);
|