packages/pass/store/types.ts

   1 import type { AuthService } from '@proton/pass/lib/auth/service';
   2 import type { AuthStore } from '@proton/pass/lib/auth/store';
   3 import type {
   4     AnyStorage,
   5     AppState,
   6     AppStatus,
   7     ClientEndpoint,
   8     LocalStoreData,
   9     MaybeNull,
  10     MaybePromise,
  11 } from '@proton/pass/types';
  12 import type { TelemetryEvent } from '@proton/pass/types/data/telemetry';
  13 import type { EncryptedPassCache } from '@proton/pass/types/worker/cache';
  14
  15 import type { Notification } from './actions/enhancers/notification';
  16 import type { FeatureFlagState, rootReducer } from './reducers';
  17 import type { ProxiedSettings } from './reducers/settings';
  18
  19 export type State = ReturnType<typeof rootReducer>;
  20 export type Telemetry = { start: () => void; stop: () => void; push: (event: TelemetryEvent) => Promise<boolean> };
  21 export type PassSaga = (options: RootSagaOptions) => Generator;
  22 export type PassBootResult =
  23     | { ok: true; fromCache: boolean; offline?: boolean; version?: string }
  24     | { ok: false; clearCache: boolean };
  25
  26 export interface RootSagaOptions {
  27     /** defines the current client type */
  28     endpoint: ClientEndpoint;
  29
  30     getAppState: () => AppState;
  31     getAuthService: () => AuthService;
  32     getAuthStore: () => AuthStore;
  33     getSettings: () => MaybePromise<ProxiedSettings>;
  34     getTelemetry: () => MaybeNull<Telemetry>;
  35
  36     setAppStatus: (status: AppStatus) => void;
  37
  38     /** Fine-tune the event channel polling interval - this will
  39      * be called after each polling run to set the next value */
  40     getPollingInterval: () => number;
  41     /** Define the initial polling delay : this is especially useful
  42      * to avoid immediately spawning the event channels after the
  43      * service worker was killed by the browser */
  44     getPollingDelay?: (pollingInterval: number, lastCalledAt?: number) => number;
  45
  46     /** Retrieves the encrypted cache from whatever storage
  47      * the current client is using for persisting data */
  48     getCache: () => Promise<Partial<EncryptedPassCache>>;
  49     /** Persists the stringified encrypted cache to whatever storage the
  50      * current client is using for persisting data */
  51     setCache: (encrypted: EncryptedPassCache) => Promise<void>;
  52
  53     /** Retrieves storage for the given client */
  54     getStorage?: () => AnyStorage<LocalStoreData>;
  55
  56     /** Callback with the result of the boot sequence. The `clearCache`
  57      * flag indicates if the boot failure should result in a cache wipe */
  58     onBoot?: (result: PassBootResult) => void;
  59
  60     /** Callback used when account locale is updated */
  61     onLocaleUpdated?: (locale: string) => void;
  62
  63     /** Callback used when the local beta flag is updated */
  64     onBetaUpdated?: (enabled: boolean) => MaybePromise<void>;
  65
  66     /** Callback for handling notification effects */
  67     onNotification?: (notification: Notification) => void;
  68
  69     /** Callback for propagating feature flags updates */
  70     onFeatureFlags?: (features: FeatureFlagState) => void;
  71
  72     /** Called whenever some changes were committed to the items state */
  73     onItemsUpdated?: () => void;
  74
  75     /** Callback triggered when settings have been updated: leverage
  76      * this to persist the settings to storage if needed. */
  77     onSettingsUpdated?: (settings: ProxiedSettings) => MaybePromise<void>;
  78 }