@narumitw/pi-sync 0.50.3 → 0.51.1

package/src/settings/settings-types.ts

@@ -3,112 +3,114 @@ export type StorageConnectionType = "s3" | "git" | "webdav";
 export type OnSwitchAction = "ask-before-pull" | "pull-after-switch" | "switch-only";
 
 export interface S3CredentialsSettings {
-	accessKeyId: string;
-	secretAccessKey: string;
-	sessionToken?: string;
-	[key: string]: unknown;
+  accessKeyId: string;
+  secretAccessKey: string;
+  sessionToken?: string;
+  [key: string]: unknown;
 }
 
 export interface WebDavCredentialsSettings {
-	username: string;
-	password: string;
-	[key: string]: unknown;
+  username: string;
+  password: string;
+  [key: string]: unknown;
 }
 
 export interface S3StorageConnectionSettings {
-	type: "s3";
-	endpoint: string;
-	region: string;
-	credentials: S3CredentialsSettings;
-	remote?: never;
-	url?: never;
-	[key: string]: unknown;
+  type: "s3";
+  endpoint: string;
+  region: string;
+  credentials: S3CredentialsSettings;
+  remote?: never;
+  url?: never;
+  [key: string]: unknown;
 }
 
 export interface GitStorageConnectionSettings {
-	type: "git";
-	remote: string;
-	endpoint?: never;
-	region?: never;
-	credentials?: never;
-	url?: never;
-	[key: string]: unknown;
+  type: "git";
+  remote: string;
+  endpoint?: never;
+  region?: never;
+  credentials?: never;
+  url?: never;
+  [key: string]: unknown;
 }
 
 export interface WebDavStorageConnectionSettings {
-	type: "webdav";
-	url: string;
-	credentials: WebDavCredentialsSettings;
-	endpoint?: never;
-	region?: never;
-	remote?: never;
-	[key: string]: unknown;
+  type: "webdav";
+  url: string;
+  credentials: WebDavCredentialsSettings;
+  endpoint?: never;
+  region?: never;
+  remote?: never;
+  [key: string]: unknown;
 }
 
 export type StorageConnectionSettings =
-	| S3StorageConnectionSettings
-	| GitStorageConnectionSettings
-	| WebDavStorageConnectionSettings;
+  | S3StorageConnectionSettings
+  | GitStorageConnectionSettings
+  | WebDavStorageConnectionSettings;
 
 export interface CommonSyncSetupStorageSettings {
-	connection: string;
-	path: string;
-	[key: string]: unknown;
+  connection: string;
+  path: string;
+  [key: string]: unknown;
 }
 
 export interface S3SyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
-	bucket: string;
-	branch?: never;
+  bucket: string;
+  branch?: never;
 }
 
 export interface GitSyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
-	branch: string;
-	bucket?: never;
+  branch: string;
+  bucket?: never;
 }
 
 export interface WebDavSyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
-	bucket?: never;
-	branch?: never;
+  bucket?: never;
+  branch?: never;
 }
 
 export type SyncSetupStorageSettings =
-	| S3SyncSetupStorageSettings
-	| GitSyncSetupStorageSettings
-	| WebDavSyncSetupStorageSettings;
+  | S3SyncSetupStorageSettings
+  | GitSyncSetupStorageSettings
+  | WebDavSyncSetupStorageSettings;
 
 export interface SyncPolicySettings {
-	include: string[];
-	automatic: boolean;
-	[key: string]: unknown;
+  include: string[];
+  automatic: boolean;
+  [key: string]: unknown;
 }
 
 export interface SyncSetupSettings {
-	storage: SyncSetupStorageSettings;
-	sync: SyncPolicySettings;
-	[key: string]: unknown;
+  storage: SyncSetupStorageSettings;
+  sync: SyncPolicySettings;
+  [key: string]: unknown;
 }
 
 export interface PiSyncSettingsV3 {
-	version: 3;
-	activeSyncSetup?: string;
-	onSwitch: OnSwitchAction;
-	skipSecretScan?: boolean;
-	storageConnections: Record<string, StorageConnectionSettings>;
-	syncSetups: Record<string, SyncSetupSettings>;
-	[key: string]: unknown;
+  version: 3;
+  activeSyncSetup?: string;
+  onSwitch: OnSwitchAction;
+  skipSecretScan?: boolean;
+  showStatus?: boolean;
+  storageConnections: Record<string, StorageConnectionSettings>;
+  syncSetups: Record<string, SyncSetupSettings>;
+  [key: string]: unknown;
 }
 
 export interface SyncConfig<Backend extends ResolvedSyncBackend = ResolvedS3Backend> {
-	setupName: string;
-	connectionName: string;
-	storagePath: string;
-	/** Snapshot/wire identity retained behind the settings normalization boundary. */
-	snapshotIdentity: string;
-	include: string[];
-	automatic: boolean;
-	onSwitch: OnSwitchAction;
-	skipSecretScan: boolean;
-	backend: Backend;
+  setupName: string;
+  connectionName: string;
+  storagePath: string;
+  /** Snapshot/wire identity retained behind the settings normalization boundary. */
+  snapshotIdentity: string;
+  include: string[];
+  automatic: boolean;
+  onSwitch: OnSwitchAction;
+  skipSecretScan: boolean;
+  showStatus: boolean;
+  backend: Backend;
 }
 
 export type AnySyncConfig = SyncConfig<ResolvedSyncBackend>;
@@ -116,13 +118,14 @@ export type CommonSyncConfig = Omit<AnySyncConfig, "backend">;
 
 /** UI projection over a fully validated v3 setup; it is never persisted directly. */
 export interface PartialConfig {
-	setupName: string;
-	connectionName: string;
-	storageKind: StorageConnectionType;
-	storagePath: string;
-	include: string[];
-	automatic: boolean;
-	onSwitch: OnSwitchAction;
-	bucket?: string;
-	branch?: string;
+  setupName: string;
+  connectionName: string;
+  storageKind: StorageConnectionType;
+  storagePath: string;
+  include: string[];
+  automatic: boolean;
+  onSwitch: OnSwitchAction;
+  showStatus: boolean;
+  bucket?: string;
+  branch?: string;
 }