@narumitw/pi-sync 0.50.2 → 0.51.0

package/docs/settings.md

@@ -4,6 +4,7 @@
 
 - [Complete version 3 example](#complete-version-3-example)
 - [Required backend shapes](#required-backend-shapes)
+- [Status display](#status-display)
 - [Secret scanning](#secret-scanning)
 - [Included content](#included-content)
 - [Unsupported old settings and recovery](#unsupported-old-settings-and-recovery)
@@ -36,6 +37,7 @@ If both paths exist, `pi-sync.json` wins and the legacy file remains untouched.
   "activeSyncSetup": "home",
   "onSwitch": "ask-before-pull",
   "skipSecretScan": false,
+  "showStatus": true,
   "storageConnections": {
     "r2": {
       "type": "s3",
@@ -140,6 +142,13 @@ The global **After switching setup (all setups)** setting persists as `onSwitch`
 - `pull-after-switch` — require observable UI and start the normal reviewed pull;
 - `switch-only` — switch without reading or applying remote content.
 
+### Status display
+
+The global `showStatus` setting accepts a boolean and defaults to `true` when omitted from an existing version 3 document.
+Set it through **/sync → Settings → Show status (all setups)**; changes are saved and applied immediately for every setup.
+When `false`, pi-sync clears and suppresses status text for background checks, manual and automatic transfers, and review attention.
+TUI review widgets and TUI/RPC notifications remain available, and lifecycle cleanup still clears any stale status owned by pi-sync.
+
 ### Secret scanning
 
 The global `skipSecretScan` setting accepts a boolean and defaults to `false`, including when omitted from an existing version 3 document.

package/package.json

@@ -1,64 +1,63 @@
 {
-	"name": "@narumitw/pi-sync",
-	"version": "0.50.2",
-	"description": "Pi extension that syncs Pi configuration through Git, WebDAV, Cloudflare R2, or S3-compatible storage.",
-	"type": "module",
-	"license": "MIT",
-	"private": false,
-	"keywords": [
-		"pi-package",
-		"pi-extension",
-		"pi",
-		"sync",
-		"r2",
-		"s3",
-		"webdav",
-		"nextcloud",
-		"synology",
-		"git",
-		"github",
-		"gitlab",
-		"forgejo"
-	],
-	"files": [
-		"src",
-		"dist",
-		"docs",
-		"README.md",
-		"LICENSE"
-	],
-	"pi": {
-		"extensions": [
-			"./dist/index.ts"
-		]
-	},
-	"scripts": {
-		"build": "node scripts/build-runtime.mjs",
-		"check": "npm run build && biome check . && npm run typecheck",
-		"format": "biome check --write .",
-		"prepack": "npm run build",
-		"typecheck": "tsc --noEmit"
-	},
-	"dependencies": {
-		"@narumitw/pi-tui-kit": "^0.59.0",
-		"fast-xml-parser": "^5.11.1",
-		"proper-lockfile": "^4.1.2"
-	},
-	"devDependencies": {
-		"@biomejs/biome": "2.5.11",
-		"@earendil-works/pi-coding-agent": "0.85.0",
-		"@earendil-works/pi-tui": "0.85.0",
-		"@types/proper-lockfile": "^4.1.4",
-		"esbuild": "0.28.2",
-		"typescript": "7.0.2"
-	},
-	"peerDependencies": {
-		"@earendil-works/pi-coding-agent": "*",
-		"@earendil-works/pi-tui": "*"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/narumiruna/pi-extensions",
-		"directory": "packages/pi-sync"
-	}
+  "name": "@narumitw/pi-sync",
+  "version": "0.51.0",
+  "description": "Pi extension that syncs Pi configuration through Git, WebDAV, Cloudflare R2, or S3-compatible storage.",
+  "type": "module",
+  "license": "MIT",
+  "private": false,
+  "keywords": [
+    "pi-package",
+    "pi-extension",
+    "pi",
+    "sync",
+    "r2",
+    "s3",
+    "webdav",
+    "nextcloud",
+    "synology",
+    "git",
+    "github",
+    "gitlab",
+    "forgejo"
+  ],
+  "files": [
+    "src",
+    "dist",
+    "docs",
+    "README.md",
+    "LICENSE"
+  ],
+  "pi": {
+    "extensions": [
+      "./dist/index.ts"
+    ]
+  },
+  "scripts": {
+    "build": "node scripts/build-runtime.mjs",
+    "check": "npm run build && biome check . && npm run typecheck",
+    "format": "biome check --write .",
+    "prepack": "npm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@narumitw/pi-tui-kit": "^0.59.0",
+    "fast-xml-parser": "^5.11.1",
+    "proper-lockfile": "^4.1.2"
+  },
+  "devDependencies": {
+    "@earendil-works/pi-coding-agent": "0.85.1",
+    "@earendil-works/pi-tui": "0.85.1",
+    "@types/proper-lockfile": "^4.1.4",
+    "esbuild": "0.28.2",
+    "typescript": "7.0.2"
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*",
+    "@earendil-works/pi-tui": "*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/narumiruna/pi-extensions",
+    "directory": "packages/pi-sync"
+  }
 }

package/src/backends/backend-factory.ts

@@ -2,22 +2,22 @@ import type { AnySyncConfig } from "../settings/settings-types.js";
 import type { SyncBackend } from "./sync-backend.js";
 
 export type SyncBackendFactory = {
-	bivarianceHack(config: AnySyncConfig): SyncBackend | Promise<SyncBackend>;
+  bivarianceHack(config: AnySyncConfig): SyncBackend | Promise<SyncBackend>;
 }["bivarianceHack"];
 
 export const createSyncBackend: SyncBackendFactory = async (config) => {
-	switch (config.backend.type) {
-		case "s3": {
-			const { S3SyncBackend } = await import("./s3/s3-backend.js");
-			return new S3SyncBackend(config.backend);
-		}
-		case "webdav": {
-			const { WebDavSyncBackend } = await import("./webdav/webdav-backend.js");
-			return new WebDavSyncBackend(config.backend);
-		}
-		case "git": {
-			const { GitSyncBackend } = await import("./git/git-backend.js");
-			return new GitSyncBackend(config.backend);
-		}
-	}
+  switch (config.backend.type) {
+    case "s3": {
+      const { S3SyncBackend } = await import("./s3/s3-backend.js");
+      return new S3SyncBackend(config.backend);
+    }
+    case "webdav": {
+      const { WebDavSyncBackend } = await import("./webdav/webdav-backend.js");
+      return new WebDavSyncBackend(config.backend);
+    }
+    case "git": {
+      const { GitSyncBackend } = await import("./git/git-backend.js");
+      return new GitSyncBackend(config.backend);
+    }
+  }
 };

package/src/backends/backend-identity.ts

@@ -3,38 +3,38 @@ import { normalizeGitRemoteIdentity } from "./git/git-config.js";
 import { normalizeWebDavIdentityUrl } from "./webdav/webdav-config.js";
 
 export function backendIdentityCoordinates(config: AnySyncConfig) {
-	switch (config.backend.type) {
-		case "s3":
-			return JSON.stringify([
-				"s3",
-				normalizeEndpointIdentity(config.backend.profile.endpoint),
-				config.backend.destination.bucket,
-				config.storagePath,
-			]);
-		case "git":
-			return JSON.stringify([
-				"git",
-				normalizeGitRemoteIdentity(config.backend.profile.remote),
-				config.backend.destination.branch,
-				config.storagePath,
-			]);
-		case "webdav":
-			return JSON.stringify([
-				"webdav",
-				normalizeWebDavIdentityUrl(config.backend.profile.url),
-				config.backend.profile.username,
-				config.storagePath,
-			]);
-	}
+  switch (config.backend.type) {
+    case "s3":
+      return JSON.stringify([
+        "s3",
+        normalizeEndpointIdentity(config.backend.profile.endpoint),
+        config.backend.destination.bucket,
+        config.storagePath,
+      ]);
+    case "git":
+      return JSON.stringify([
+        "git",
+        normalizeGitRemoteIdentity(config.backend.profile.remote),
+        config.backend.destination.branch,
+        config.storagePath,
+      ]);
+    case "webdav":
+      return JSON.stringify([
+        "webdav",
+        normalizeWebDavIdentityUrl(config.backend.profile.url),
+        config.backend.profile.username,
+        config.storagePath,
+      ]);
+  }
 }
 
 export function normalizeEndpointIdentity(endpoint: string) {
-	try {
-		const url = new URL(endpoint.trim());
-		url.hostname = url.hostname.toLowerCase();
-		url.pathname = url.pathname.replace(/\/+$/gu, "");
-		return url.toString().replace(/\/$/u, "");
-	} catch {
-		return endpoint.trim();
-	}
+  try {
+    const url = new URL(endpoint.trim());
+    url.hostname = url.hostname.toLowerCase();
+    url.pathname = url.pathname.replace(/\/+$/gu, "");
+    return url.toString().replace(/\/$/u, "");
+  } catch {
+    return endpoint.trim();
+  }
 }

package/src/backends/backend-types.ts

@@ -1,81 +1,81 @@
 import type { SnapshotSelection } from "../snapshot/snapshot-types.js";
 /** Backend-only resolved S3 connection fields. */
 export interface ResolvedS3StorageProfile {
-	kind: "r2" | "s3-compatible";
-	endpoint: string;
-	region: string;
-	accessKeyId: string;
-	secretAccessKey: string;
-	sessionToken?: string;
+  kind: "r2" | "s3-compatible";
+  endpoint: string;
+  region: string;
+  accessKeyId: string;
+  secretAccessKey: string;
+  sessionToken?: string;
 }
 
 /** Backend-only coordinates. `prefix` is the complete reviewed v3 storage path. */
 export interface ResolvedS3Destination {
-	bucket: string;
-	prefix: string;
-	/** Snapshot/wire identity; never derived from the local setup name. */
-	namespace: string;
+  bucket: string;
+  prefix: string;
+  /** Snapshot/wire identity; never derived from the local setup name. */
+  namespace: string;
 }
 
 export interface ResolvedS3Backend {
-	type: "s3";
-	profile: ResolvedS3StorageProfile;
-	destination: ResolvedS3Destination;
+  type: "s3";
+  profile: ResolvedS3StorageProfile;
+  destination: ResolvedS3Destination;
 }
 
 export interface ResolvedWebDavStorageProfile {
-	kind: "webdav";
-	url: string;
-	username: string;
-	password: string;
+  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;
+  path: string;
+  namespace: string;
 }
 
 export interface ResolvedWebDavBackend {
-	type: "webdav";
-	profile: ResolvedWebDavStorageProfile;
-	destination: ResolvedWebDavDestination;
+  type: "webdav";
+  profile: ResolvedWebDavStorageProfile;
+  destination: ResolvedWebDavDestination;
 }
 
 export interface ResolvedGitStorageProfile {
-	kind: "git";
-	remote: string;
+  kind: "git";
+  remote: string;
 }
 
 /** Backend-only coordinates. `directory` is the complete reviewed v3 storage path. */
 export interface ResolvedGitDestination {
-	branch: string;
-	directory: string;
-	namespace: string;
+  branch: string;
+  directory: string;
+  namespace: string;
 }
 
 export interface ResolvedGitBackend {
-	type: "git";
-	profile: ResolvedGitStorageProfile;
-	destination: ResolvedGitDestination;
+  type: "git";
+  profile: ResolvedGitStorageProfile;
+  destination: ResolvedGitDestination;
 }
 
 export type ResolvedSyncBackend = ResolvedS3Backend | ResolvedWebDavBackend | ResolvedGitBackend;
 
 export interface LatestPointer {
-	version: number;
-	profile: string;
-	snapshot: string;
-	sha256: string;
-	createdAt: string;
-	machine: string;
-	syncSessions?: boolean;
-	/** Lightweight projection; the immutable snapshot remains authoritative. */
-	selection?: SnapshotSelection;
+  version: number;
+  profile: string;
+  snapshot: string;
+  sha256: string;
+  createdAt: string;
+  machine: string;
+  syncSessions?: boolean;
+  /** Lightweight projection; the immutable snapshot remains authoritative. */
+  selection?: SnapshotSelection;
 }
 
 export interface RemoteObject<T> {
-	value?: T;
-	etag?: string;
-	missing: boolean;
+  value?: T;
+  etag?: string;
+  missing: boolean;
 }