@narumitw/pi-sync 0.31.0 → 0.34.0

package/src/types.ts

@@ -1,72 +1,190 @@
-export type StorageProfileKind = "r2" | "s3-compatible";
-export type TargetSwitchAction = "ask" | "pull" | "switch-only";
-
-export interface StorageProfileSettings {
-	kind?: StorageProfileKind;
-	endpoint?: string;
-	region?: string;
-	accessKeyId?: string;
-	secretAccessKey?: string;
+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;
 }
 
-export interface SyncTargetSettings {
-	profile?: string;
-	bucket?: string;
-	prefix?: string;
-	namespace?: string;
-	autoSync?: boolean;
-	syncFiles?: unknown;
-	syncSessions?: boolean;
-	extraFiles?: unknown;
+export interface WebDavCredentialsSettings {
+	username: string;
+	password: string;
+	[key: string]: unknown;
 }
 
-export interface PiSyncSettingsV2 {
-	version: 2;
-	activeTarget?: string;
-	targetSwitchAction?: TargetSwitchAction;
-	profiles?: Record<string, StorageProfileSettings>;
-	targets?: Record<string, SyncTargetSettings>;
+export interface S3StorageConnectionSettings {
+	type: "s3";
+	endpoint: string;
+	region: string;
+	credentials: S3CredentialsSettings;
+	remote?: never;
+	url?: never;
 	[key: string]: unknown;
 }
 
-export interface SyncConfig {
-	endpoint: string;
+export interface GitStorageConnectionSettings {
+	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;
+}
+
+export type StorageConnectionSettings =
+	| S3StorageConnectionSettings
+	| GitStorageConnectionSettings
+	| WebDavStorageConnectionSettings;
+
+export interface CommonSyncSetupStorageSettings {
+	connection: string;
+	path: string;
+	[key: string]: unknown;
+}
+
+export interface S3SyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
 	bucket: string;
+	branch?: never;
+}
+
+export interface GitSyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
+	branch: string;
+	bucket?: never;
+}
+
+export interface WebDavSyncSetupStorageSettings extends CommonSyncSetupStorageSettings {
+	bucket?: never;
+	branch?: never;
+}
+
+export type SyncSetupStorageSettings =
+	| S3SyncSetupStorageSettings
+	| GitSyncSetupStorageSettings
+	| WebDavSyncSetupStorageSettings;
+
+export interface SyncPolicySettings {
+	include: string[];
+	automatic: boolean;
+	[key: string]: unknown;
+}
+
+export interface SyncSetupSettings {
+	storage: SyncSetupStorageSettings;
+	sync: SyncPolicySettings;
+	[key: string]: unknown;
+}
+
+export interface PiSyncSettingsV3 {
+	version: 3;
+	activeSyncSetup?: string;
+	onSwitch: OnSwitchAction;
+	storageConnections: Record<string, StorageConnectionSettings>;
+	syncSetups: Record<string, SyncSetupSettings>;
+	[key: string]: unknown;
+}
+
+/** Backend-only resolved S3 connection fields. */
+export interface ResolvedS3StorageProfile {
+	kind: "r2" | "s3-compatible";
+	endpoint: string;
 	region: string;
 	accessKeyId: string;
 	secretAccessKey: string;
 	sessionToken?: string;
-	/** Remote namespace retained as `profile` for snapshot/wire compatibility. */
-	profile: string;
+}
+
+/** Backend-only coordinates. `prefix` is the complete reviewed v3 storage path. */
+export interface ResolvedS3Destination {
+	bucket: string;
 	prefix: string;
-	target?: string;
-	storageProfile?: string;
-	storageKind?: StorageProfileKind;
-	autoSync?: boolean;
-	settingsVersion?: 1 | 2;
-	syncFiles?: string[];
-	syncSessions: boolean;
-	extraFiles: string[];
+	/** Snapshot/wire identity; never derived from the local setup name. */
+	namespace: string;
+}
+
+export interface ResolvedS3Backend {
+	type: "s3";
+	profile: ResolvedS3StorageProfile;
+	destination: ResolvedS3Destination;
+}
+
+export interface ResolvedWebDavStorageProfile {
+	kind: "webdav";
+	url: string;
+	username: string;
+	password: string;
+}
+
+/** Backend-only coordinates. `path` is the complete reviewed v3 storage path. */
+export interface ResolvedWebDavDestination {
+	path: string;
+	namespace: string;
+}
+
+export interface ResolvedWebDavBackend {
+	type: "webdav";
+	profile: ResolvedWebDavStorageProfile;
+	destination: ResolvedWebDavDestination;
+}
+
+export interface ResolvedGitStorageProfile {
+	kind: "git";
+	remote: string;
+}
+
+/** Backend-only coordinates. `directory` is the complete reviewed v3 storage path. */
+export interface ResolvedGitDestination {
+	branch: string;
+	directory: string;
+	namespace: string;
+}
+
+export interface ResolvedGitBackend {
+	type: "git";
+	profile: ResolvedGitStorageProfile;
+	destination: ResolvedGitDestination;
+}
+
+export type ResolvedSyncBackend = ResolvedS3Backend | ResolvedWebDavBackend | ResolvedGitBackend;
+
+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;
+	backend: Backend;
 }
 
+export type AnySyncConfig = SyncConfig<ResolvedSyncBackend>;
+export type CommonSyncConfig = Omit<AnySyncConfig, "backend">;
+
+/** UI projection over a fully validated v3 setup; it is never persisted directly. */
 export interface PartialConfig {
-	target?: string;
-	storageProfile?: string;
-	storageKind?: StorageProfileKind;
-	settingsVersion?: 1 | 2;
-	endpoint?: string;
+	setupName: string;
+	connectionName: string;
+	storageKind: StorageConnectionType;
+	storagePath: string;
+	include: string[];
+	automatic: boolean;
+	onSwitch: OnSwitchAction;
 	bucket?: string;
-	region?: string;
-	accessKeyId?: string;
-	secretAccessKey?: string;
-	sessionToken?: string;
-	profile?: string;
-	prefix?: string;
-	autoSync?: boolean | string;
-	syncFiles?: unknown;
-	syncSessions?: boolean | string;
-	extraFiles?: unknown;
+	branch?: string;
 }
 
 export interface SnapshotFile {
@@ -80,6 +198,7 @@ export interface Snapshot {
 	id: string;
 	createdAt: string;
 	machine: string;
+	/** Backend-scoped remote identity retained in the snapshot wire format. */
 	profile: string;
 	syncSessions?: boolean;
 	files: SnapshotFile[];
@@ -105,8 +224,11 @@ export interface SyncState {
 	version: number;
 	profile: string;
 	lastAppliedSnapshot?: string;
+	lastRemoteRevision?: string;
 	lastRemoteEtag?: string;
 	lastFileHashes: Record<string, string>;
+	include?: string[];
+	/** Legacy state fields are read only so v3 can detect and replace stale policy state. */
 	syncFiles?: string[];
 	syncSessions?: boolean;
 	extraFiles?: string[];
@@ -126,7 +248,7 @@ export interface CommandOptions {
 	silent: boolean;
 	reload: boolean;
 	auto: boolean;
-	target?: string;
+	setup?: string;
 	signal?: AbortSignal;
 	onCommit?: () => void;
 	args: string[];
@@ -139,9 +261,11 @@ export interface CommandArgumentCompletion {
 }
 
 export interface SnapshotOptions {
+	include?: string[];
+	sessionDir?: string;
+	/** Temporary internal projections while snapshot storage remains wire-compatible. */
 	syncFiles?: string[];
 	syncSessions?: boolean;
-	sessionDir?: string;
 	extraFiles?: string[];
 }