strapi-content-sync-pro 1.0.0 → 1.0.2

package/admin/src/components/HelpTab.jsx

@@ -1,5 +1,8 @@
 import { Box, Typography, Tabs, Divider } from '@strapi/design-system';
 
+const INTRO_VIDEO_URL = 'https://www.youtube.com/watch?v=hr3dD6dLgLQ';
+const INTRO_VIDEO_THUMBNAIL = 'https://img.youtube.com/vi/hr3dD6dLgLQ/hqdefault.jpg';
+
 const HelpSection = ({ title, children }) => (
   <Box paddingBottom={6}>
     <Typography variant="delta" tag="h3" paddingBottom={2}>{title}</Typography>
@@ -55,6 +58,61 @@ export const HelpTab = () => {
         {/* Overview Tab */}
         <Tabs.Content value="overview">
           <Box paddingTop={4}>
+            <HelpSection title="Video walkthrough">
+              <Typography variant="omega" paddingBottom={3}>
+                Watch the help video to get started:
+              </Typography>
+
+              <Box
+                background="neutral100"
+                hasRadius
+                padding={3}
+                style={{ maxWidth: '960px' }}
+              >
+                <a href={INTRO_VIDEO_URL} target="_blank" rel="noopener noreferrer" style={{ display: 'block', textDecoration: 'none' }}>
+                  <Box style={{ position: 'relative', paddingTop: '56.25%', overflow: 'hidden', borderRadius: '4px' }}>
+                    <img
+                      src={INTRO_VIDEO_THUMBNAIL}
+                      alt="Content Sync Pro — plugin intro"
+                      style={{
+                        position: 'absolute',
+                        top: 0,
+                        left: 0,
+                        width: '100%',
+                        height: '100%',
+                        objectFit: 'cover',
+                      }}
+                    />
+                    <Box
+                      style={{
+                        position: 'absolute',
+                        top: '50%',
+                        left: '50%',
+                        transform: 'translate(-50%, -50%)',
+                        width: '68px',
+                        height: '48px',
+                        backgroundColor: 'rgba(255,0,0,0.85)',
+                        borderRadius: '12px',
+                        display: 'flex',
+                        alignItems: 'center',
+                        justifyContent: 'center',
+                      }}
+                    >
+                      <svg width="24" height="24" viewBox="0 0 24 24" fill="white">
+                        <polygon points="8,5 20,12 8,19" />
+                      </svg>
+                    </Box>
+                  </Box>
+                </a>
+                <Box paddingTop={2}>
+                  <Typography variant="pi" textColor="neutral500">
+                    ▶ Watch the help video on{' '}
+                    <DocLink href={INTRO_VIDEO_URL}>YouTube</DocLink>
+                  </Typography>
+                </Box>
+              </Box>
+            </HelpSection>
+
             <HelpSection title="What is Content Sync Pro?">
               <Typography variant="omega">
                 This plugin enables data synchronization between two Strapi v5 instances. It provides a complete

package/docs/logo-horizontal.svg

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="320" viewBox="0 0 1200 320" role="img" aria-label="Content Sync Pro logo">
+  <defs>
+    <linearGradient id="csp-g" x1="40" y1="40" x2="240" y2="240" gradientUnits="userSpaceOnUse">
+      <stop offset="0" stop-color="#6C63FF"/>
+      <stop offset="1" stop-color="#4945FF"/>
+    </linearGradient>
+  </defs>
+
+  <!-- mark -->
+  <g transform="translate(24,24)">
+    <rect x="0" y="0" width="272" height="272" rx="64" fill="url(#csp-g)"/>
+    <circle cx="92" cy="120" r="22" fill="#FFFFFF" opacity="0.92"/>
+    <circle cx="180" cy="120" r="22" fill="#FFFFFF" opacity="0.92"/>
+    <g fill="none" stroke="#FFFFFF" stroke-width="12" stroke-linecap="round" stroke-linejoin="round" opacity="0.95">
+      <path d="M110 104 H172"/>
+      <path d="M172 104 L160 92"/>
+      <path d="M172 104 L160 116"/>
+      <path d="M164 136 H102"/>
+      <path d="M102 136 L114 124"/>
+      <path d="M102 136 L114 148"/>
+    </g>
+    <path d="M136 158 C156 158 172 150 182 143 V176 C182 202 164 222 136 232 C108 222 90 202 90 176 V143 C100 150 116 158 136 158 Z" fill="#FFFFFF" opacity="0.92"/>
+    <path d="M118 186 L130 198 L156 172" fill="none" stroke="#4945FF" stroke-width="12" stroke-linecap="round" stroke-linejoin="round"/>
+  </g>
+
+  <!-- wordmark -->
+  <g transform="translate(340,88)">
+    <text x="0" y="0" font-size="54" font-weight="700" font-family="Inter, Segoe UI, Arial, sans-serif" fill="#111827">Content Sync</text>
+    <text x="0" y="70" font-size="54" font-weight="700" font-family="Inter, Segoe UI, Arial, sans-serif" fill="#4945FF">Pro</text>
+    <text x="140" y="70" font-size="22" font-weight="500" font-family="Inter, Segoe UI, Arial, sans-serif" fill="#6B7280">Strapi v5 plugin</text>
+  </g>
+</svg>

package/docs/logo-mark.svg

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 512 512" role="img" aria-label="Content Sync Pro logo mark">
+  <defs>
+    <linearGradient id="csp-g" x1="96" y1="96" x2="416" y2="416" gradientUnits="userSpaceOnUse">
+      <stop offset="0" stop-color="#6C63FF"/>
+      <stop offset="1" stop-color="#4945FF"/>
+    </linearGradient>
+    <filter id="csp-shadow" x="-20%" y="-20%" width="140%" height="140%" color-interpolation-filters="sRGB">
+      <feDropShadow dx="0" dy="8" stdDeviation="10" flood-color="#000" flood-opacity="0.18"/>
+    </filter>
+  </defs>
+
+  <!-- background badge -->
+  <rect x="56" y="56" width="400" height="400" rx="92" fill="url(#csp-g)" filter="url(#csp-shadow)"/>
+
+  <!-- sync nodes -->
+  <circle cx="182" cy="236" r="34" fill="#FFFFFF" opacity="0.92"/>
+  <circle cx="330" cy="236" r="34" fill="#FFFFFF" opacity="0.92"/>
+
+  <!-- bi-directional arrows -->
+  <g fill="none" stroke="#FFFFFF" stroke-width="18" stroke-linecap="round" stroke-linejoin="round" opacity="0.95">
+    <!-- top arrow: left -> right -->
+    <path d="M208 210 H320"/>
+    <path d="M320 210 L302 192"/>
+    <path d="M320 210 L302 228"/>
+
+    <!-- bottom arrow: right -> left -->
+    <path d="M304 262 H192"/>
+    <path d="M192 262 L210 244"/>
+    <path d="M192 262 L210 280"/>
+  </g>
+
+  <!-- safety shield + check ("pro" / enforcement) -->
+  <g transform="translate(0,2)">
+    <path d="M256 310 C290 310 316 296 332 284 V338 C332 380 302 412 256 430 C210 412 180 380 180 338 V284 C196 296 222 310 256 310 Z" fill="#FFFFFF" opacity="0.92"/>
+    <path d="M226 356 L246 376 L292 330" fill="none" stroke="#4945FF" stroke-width="18" stroke-linecap="round" stroke-linejoin="round"/>
+  </g>
+</svg>

package/docs/logo-square.svg

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="1024" height="1024" viewBox="0 0 1024 1024" role="img" aria-label="Content Sync Pro square logo">
+  <defs>
+    <linearGradient id="csp-g" x1="160" y1="160" x2="864" y2="864" gradientUnits="userSpaceOnUse">
+      <stop offset="0" stop-color="#6C63FF"/>
+      <stop offset="1" stop-color="#4945FF"/>
+    </linearGradient>
+  </defs>
+
+  <rect x="112" y="112" width="800" height="800" rx="180" fill="url(#csp-g)"/>
+
+  <circle cx="364" cy="470" r="68" fill="#FFFFFF" opacity="0.92"/>
+  <circle cx="660" cy="470" r="68" fill="#FFFFFF" opacity="0.92"/>
+
+  <g fill="none" stroke="#FFFFFF" stroke-width="36" stroke-linecap="round" stroke-linejoin="round" opacity="0.95">
+    <path d="M416 418 H640"/>
+    <path d="M640 418 L604 382"/>
+    <path d="M640 418 L604 454"/>
+
+    <path d="M608 522 H384"/>
+    <path d="M384 522 L420 486"/>
+    <path d="M384 522 L420 558"/>
+  </g>
+
+  <path d="M512 620 C580 620 632 592 664 568 V676 C664 760 604 824 512 860 C420 824 360 760 360 676 V568 C392 592 444 620 512 620 Z" fill="#FFFFFF" opacity="0.92"/>
+  <path d="M452 712 L492 752 L588 656" fill="none" stroke="#4945FF" stroke-width="36" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-content-sync-pro",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Strapi v5 plugin to copy, migrate, and live-sync content, media, and data between multiple Strapi environments with bi-directional sync, field-level policies, scheduling, and alerts.",
   "license": "MIT",
   "author": {
@@ -59,6 +59,7 @@
   "files": [
     "admin/",
     "server/",
+    "docs/",
     "README.md",
     "LICENSE"
   ],

package/server/src/services/sync.js

@@ -160,6 +160,147 @@ module.exports = ({ strapi }) => {
       return { syncedAt: new Date().toISOString(), results };
     },
 
+    /**
+     * Sync a single content type using a given profile.
+     * Called by the execution service (on-demand / scheduled / live runs).
+     *
+     * options:
+     *   - profile: sync profile { contentType, direction, conflictStrategy, isSimple, fieldPolicies }
+     *   - syncDependencies: boolean (currently informational; dependency resolution handled upstream)
+     *   - dependencyDepth: number
+     */
+    async syncContentType(uid, options = {}) {
+      if (!uid) {
+        throw new Error('Content type uid is required');
+      }
+
+      const logService = plugin().service('syncLog');
+      const configService = plugin().service('config');
+      const syncConfigService = plugin().service('syncConfig');
+      const syncProfilesService = plugin().service('syncProfiles');
+      const executionService = plugin().service('syncExecution');
+
+      const remoteConfig = await configService.getConfig({ safe: false });
+      if (!remoteConfig || !remoteConfig.baseUrl) {
+        throw new Error('Remote server not configured');
+      }
+
+      const { profile } = options;
+      const syncConfig = await syncConfigService.getSyncConfig();
+      const ctConfig = (syncConfig.contentTypes || []).find((ct) => ct.uid === uid) || { uid, fields: [] };
+
+      const direction = profile?.direction || ctConfig.direction || 'both';
+      const conflictStrategy = profile?.conflictStrategy || syncConfig.conflictStrategy || 'latest';
+      const fields = ctConfig.fields || [];
+
+      // Field-level policies: prefer the policies on the provided profile,
+      // otherwise fall back to the active profile for the content type.
+      let fieldPolicies = null;
+      if (profile) {
+        if (!profile.isSimple && Array.isArray(profile.fieldPolicies) && profile.fieldPolicies.length > 0) {
+          fieldPolicies = {};
+          for (const fp of profile.fieldPolicies) {
+            fieldPolicies[fp.field] = fp.direction;
+          }
+        }
+      } else {
+        fieldPolicies = await syncProfilesService.getFieldPoliciesForContentType(uid);
+      }
+
+      const globalExec = (await executionService.getGlobalSettings?.()) || {};
+      const pageSize = Number(globalExec.syncPageSize) || 100;
+
+      const timestamps = await getLastSyncTimestamps();
+      const lastSyncAt = timestamps[uid] || null;
+      const syncStartTime = new Date().toISOString();
+
+      let pushed = 0;
+      let pulled = 0;
+      let errors = 0;
+
+      try {
+        const localRecords = await fetchLocalRecords(strapi, uid, { fields, lastSyncAt, pageSize });
+        const remoteRecords = await fetchRemoteRecords(remoteConfig, uid, { fields, lastSyncAt, pageSize });
+
+        const diff = compareRecords(localRecords, remoteRecords, { direction, conflictStrategy });
+
+        for (const { local } of diff.toPush) {
+          try {
+            const filteredRecord = syncProfilesService.filterFieldsByPolicy(local, fieldPolicies, 'push');
+            await applyRemote(remoteConfig, uid, filteredRecord, fields);
+            pushed++;
+          } catch (err) {
+            errors++;
+            await logService.log({ action: 'push', contentType: uid, syncId: local.syncId, direction: 'push', status: 'error', message: err.message });
+          }
+        }
+
+        for (const { remote } of diff.toPull) {
+          try {
+            const filteredRecord = syncProfilesService.filterFieldsByPolicy(remote, fieldPolicies, 'pull');
+            await applyLocal(strapi, uid, filteredRecord, fields);
+            pulled++;
+          } catch (err) {
+            errors++;
+            await logService.log({ action: 'pull', contentType: uid, syncId: remote.syncId, direction: 'pull', status: 'error', message: err.message });
+          }
+        }
+
+        for (const record of diff.toCreateRemote) {
+          try {
+            const filteredRecord = syncProfilesService.filterFieldsByPolicy(record, fieldPolicies, 'push');
+            await applyRemote(remoteConfig, uid, filteredRecord, fields);
+            pushed++;
+          } catch (err) {
+            errors++;
+            await logService.log({ action: 'create_remote', contentType: uid, syncId: record.syncId, direction: 'push', status: 'error', message: err.message });
+          }
+        }
+
+        for (const record of diff.toCreateLocal) {
+          try {
+            const filteredRecord = syncProfilesService.filterFieldsByPolicy(record, fieldPolicies, 'pull');
+            await applyLocal(strapi, uid, filteredRecord, fields);
+            pulled++;
+          } catch (err) {
+            errors++;
+            await logService.log({ action: 'create_local', contentType: uid, syncId: record.syncId, direction: 'pull', status: 'error', message: err.message });
+          }
+        }
+
+        await setLastSyncTimestamp(uid, syncStartTime);
+
+        const summary = {
+          uid,
+          pushed,
+          pulled,
+          errors,
+          hasFieldPolicies: !!fieldPolicies,
+          profile: profile ? { id: profile.id, name: profile.name } : null,
+        };
+
+        await logService.log({
+          action: 'sync_complete',
+          contentType: uid,
+          direction,
+          status: errors > 0 ? 'partial' : 'success',
+          message: `Pushed: ${pushed}, Pulled: ${pulled}, Errors: ${errors}${fieldPolicies ? ' (with field policies)' : ''}`,
+          details: summary,
+        });
+
+        return { syncedAt: new Date().toISOString(), ...summary };
+      } catch (err) {
+        await logService.log({
+          action: 'sync_error',
+          contentType: uid,
+          direction,
+          status: 'error',
+          message: err.message,
+        });
+        throw err;
+      }
+    },
+
     /**
      * Step 8 — Push a single record to the remote (called by lifecycle hooks).
      * Now supports field-level policies.