strapi-content-sync-pro 1.0.2 → 1.0.4

package/README.md

@@ -1,4 +1,4 @@
-# Content Sync Pro Plugin for Strapi
+# Content Sync Pro Plugin for Strapi
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/eharain/strapi-content-sync-pro/master/docs/logo-horizontal.svg" alt="Content Sync Pro" width="720" />
@@ -14,7 +14,7 @@ A powerful Strapi v5 plugin to copy, migrate, and live-sync content, media, and
 Plugin intro: https://youtu.be/hr3dD6dLgLQ
 
 <a href="https://youtu.be/hr3dD6dLgLQ" target="_blank" rel="noopener noreferrer">
-  <img src="https://raw.githubusercontent.com/eharain/strapi-content-sync-pro/master/docs/Screenshot%202026-04-20%20160506.png" alt="Content Sync Pro � watch the intro video" width="100%" />
+  <img src="https://raw.githubusercontent.com/eharain/strapi-content-sync-pro/master/docs/Screenshot%202026-04-20%20160506.png" alt="Content Sync Pro — watch the intro video" width="100%" />
 </a>
 
 ## Screenshots
@@ -50,14 +50,19 @@ Plugin intro: https://youtu.be/hr3dD6dLgLQ
 
 ## Features
 
-- **Bi-directional Content Sync** - Push, pull, or sync both ways (Local wins, Remote wins, or Latest wins).
+- **Deployment Modes** - Paired mode (plugin on both servers) or Single-side mode (plugin only on local server).
+- **Bi-directional Content Sync** - Push, pull, or sync both ways (Local wins, Remote wins, or Latest wins) in paired mode.
 - **Media Sync** - Full media synchronization via HTTP (URL-based) or host-level file copy (`rsync`). Includes MIME type filtering and concurrency controls.
 - **Sync Profiles** - Define WHAT to sync with field-level control (Advanced mode) or preset modes.
-- **Execution Modes** - On-demand, Scheduled (interval, timeout, cron, or external scheduler), or Live (real-time) sync.
+- **Execution Modes** - On-demand, Scheduled (interval, timeout, cron, or external scheduler), Live (real-time), with per-profile execution controls.
 - **Pagination & Large Dataset Support** - Built-in pagination ensures stable memory usage even when syncing thousands of records.
 - **Dependency Analytics** - Automatically detects and syncs related entities and components in the correct order.
 - **Enforcement Checks** - Pre-sync schema compatibility validation, version checks, and server time drift checks.
 - **Alerts & Logging** - Detailed sync logs. Receive success/failure alerts via Email (using Strapi's email provider) or Webhooks.
+- **Stats & Run Reports** - Local/remote counts and newest timestamps per content type, with before/after snapshots for each sync run.
+- **Bulk Transfer** - Dedicated top-level tab for one-click full pull or full push across selectable scopes (content, media, Strapi users, admin users). Expands into per-content-type and per-media-profile chunks with page-level progress, selectable chunks, optional deletion sync, and auto-continue or manual chunk-by-chunk stepping.
+- **Pause / Resume / Cancel & Persisted History** - Bulk Transfer jobs can be paused after the current page (cursor, page number, and counters preserved), cancelled without losing progress, and resumed later from the exact saved state. Every run is stored in a persistent history so you can inspect per-chunk results and **restart** or **resume** any previous run — even after a Strapi restart.
+- **Retention Controls** - Manual clear and automatic retention limits for logs and run reports.
 - **Secure Communication** - API token authentication combined with HMAC-SHA256 request signing using a shared secret.
 
 ## Prerequisites
@@ -110,14 +115,23 @@ npm run develop
 
 ## Quick Start
 
-### Step 1: Configure Connection
-In the **Configuration** tab, set up the remote server connection.
+### Step 1: Choose Deployment Mode and Configure Connection
+In **Configuration**, choose one mode:
+- **Paired**: install and enable plugin on both local and remote servers.
+- **Single-side**: install plugin only on local server (remote plugin routes not required).
+
+Then configure Base URL, API Token, Instance ID, and Shared Secret.
 
 ### Step 2: Enable Content Types
 In the **Content Types** tab, toggle on the content types you want to sync. Default profiles are auto-generated.
 
-### Step 3: Run Sync
-In the **Sync** tab, click "Sync All Active Profiles" or run individual profiles.
+### Step 3: Align Sync Settings on Both Servers
+In **Content Types**, enable matching content types on both servers.
+In **Sync Profiles**, set compatible direction/conflict strategy.
+Then in **Sync**, configure execution mode and global page size.
+
+### Step 4: Run Sync
+In the **Sync** tab, click **Sync All Active Profiles** or run individual profiles.
 
 ## Sync Profiles
 
@@ -135,6 +149,20 @@ Configure individual field policies:
 - **Pull** - Field only pulls from remote
 - **Exclude** - Field is never synced
 
+## Deployment Modes
+
+### Paired mode
+- Plugin installed on both local and remote servers.
+- Supports push, pull, and bidirectional profiles.
+- Supports on-demand, scheduled, and live execution modes.
+- Connection test validates remote plugin endpoints.
+
+### Single-side mode
+- Plugin installed on local server only.
+- Pull-only profiles are enforced.
+- Live execution is disabled (use on-demand or scheduled).
+- Connection test validates remote reachability and API token access without requiring remote plugin routes.
+
 ## Execution Modes
 
 Configure **when** sync runs in the Sync tab:
@@ -158,14 +186,15 @@ Configure **when** sync runs in the Sync tab:
 
 Full media synchronization between Strapi instances:
 
-- **URL Strategy** (HTTP) � Works with any upload provider (local, S3, Cloudinary). Downloads and re-uploads via the Upload API.
-- **rsync Strategy** � Host-level file copy using the `rsync` binary. Fastest for local-provider setups with SSH access.
-- **Profile-based** � Create media sync profiles with direction, conflict strategy, MIME filters, filename patterns, and execution settings.
-- **DB + File Sync** � Syncs both the `plugin::upload.file` database rows and the actual file bytes.
+- **URL Strategy** (HTTP) — Works with any upload provider (local, S3, Cloudinary). Downloads and re-uploads via the Upload API.
+- **rsync Strategy** — Host-level file copy using the `rsync` binary. Fastest for local-provider setups with SSH access.
+- **Profile-based** — Create media sync profiles with direction, conflict strategy, MIME filters, filename patterns, and execution settings.
+- **DB + File Sync** — Syncs both the `plugin::upload.file` database rows and the actual file bytes.
+- **Morph Link Remapping** — Syncs `files_related_morphs` links by mapping file + related entities through documentId, then remapping to local numeric ids before insert.
 
 ## Enforcement
 
-Pre-sync validation (Configuration ? Enforcement):
+Pre-sync validation (Configuration → Enforcement):
 
 - **Schema Match** - Verify content type schemas match (strict/compatible/none)
 - **Version Check** - Verify Strapi versions (exact/minor/major/none)
@@ -173,7 +202,7 @@ Pre-sync validation (Configuration ? Enforcement):
 
 ## Alerts
 
-Get notified of sync events (Configuration ? Alerts):
+Get notified of sync events (Configuration → Alerts):
 
 - **Strapi Logs** - Logs to sync log and server console
 - **Email** - Requires Strapi email plugin configured
@@ -215,6 +244,24 @@ Sync products from a central catalog to multiple storefronts:
    - Create "Full Pull" profile for `api::product.product`
    - Set execution mode to "Scheduled" (every 5 minutes)
 
+## Stats & Data Management
+
+The **Stats** tab is split into two sub-tabs:
+
+**Current Snapshot** — live local vs remote state per content type:
+- Local vs remote record count
+- Media files and media morph stats (local, plus remote where available)
+- Newest record timestamp on each side and which side is newest (local, remote, equal)
+- Search by UID, filter by type (content / media / media morph) or newest side, and paginate large result sets
+
+**Run Reports** — before/after snapshots captured for each sync run:
+- Filter by status (all / success / failed) and paginate server-side
+- Expand any report to see the before and after row tables
+
+A top action row (shared by both sub-tabs) provides:
+- **Refresh Stats**, **Clear Logs**, **Clear Stats Reports**
+- **Max Logs** / **Max Reports** retention limits with **Save & Apply Retention** (also enforced automatically after each sync run)
+
 ## Troubleshooting
 
 ### Common Issues
@@ -222,8 +269,10 @@ Sync products from a central catalog to multiple storefronts:
 | Error | Solution |
 |-------|----------|
 | "Remote server not configured" | Add Base URL and API Token in Configuration |
-| "401 Unauthorized" | Regenerate API token on remote server |
-| "HMAC verification failed" | Ensure shared secret matches on both instances |
+| "401 Unauthorized / 403 Forbidden" | Regenerate API token and verify required permissions for synced content types (and Upload permissions for media) |
+| "HMAC verification failed" | Ensure shared secret matches on both instances in paired mode |
+| "Content type endpoint not found" | In paired mode, ensure matching content-type definitions and enabled API routes on both instances |
+| "Live mode not available" | Switch to paired mode, or use on-demand/scheduled in single-side mode |
 | "Schema mismatch" | Sync content type schemas or set enforcement to "compatible" |
 
 ### Viewing Logs
@@ -240,7 +289,7 @@ Check the **Logs** tab for detailed sync history including:
 - **Credential handling.** The optional "Generate Token" feature lets you authenticate to **your own** remote Strapi server to create an API token. Credentials are sent directly from your browser to your server via the plugin's backend proxy, used once, and **never stored** on disk, in the database, or in memory after the request completes.
 - **API Tokens** are encrypted at rest using Strapi's built-in store.
 - **HMAC-SHA256** signatures protect all inter-instance requests from tampering.
-- **Masked secrets** � API tokens and shared secrets are masked (`��������`) in all API responses.
+- **Masked secrets** — API tokens and shared secrets are masked (`••••••••`) in all API responses.
 
 ## Contributing
 
@@ -254,4 +303,4 @@ MIT License - see [LICENSE](LICENSE) for details.
 
 **Ejaz Husain Arain**
 - GitHub: [@eharain](https://github.com/eharain)
-- Email: eharain@yahoo.com
+- Email: eharain@yahoo.com