strapi-content-sync-pro 1.0.0

package/admin/src/index.js

@@ -0,0 +1,31 @@
+import { ArrowsCounterClockwise } from '@strapi/icons';
+import pluginId from './pluginId';
+
+export default {
+  register(app) {
+    app.addMenuLink({
+      to: `plugins/${pluginId}`,
+      icon: ArrowsCounterClockwise,
+      intlLabel: {
+        id: `${pluginId}.plugin.name`,
+        defaultMessage: 'Data Sync',
+      },
+      Component: async () => {
+        const { App } = await import('./pages/App');
+        return App;
+      },
+    });
+
+    app.registerPlugin({
+      id: pluginId,
+      name: pluginId,
+    });
+  },
+
+  async registerTrads({ locales }) {
+    return locales.map((locale) => ({
+      data: {},
+      locale,
+    }));
+  },
+};

package/admin/src/pages/App/index.jsx

@@ -0,0 +1,129 @@
+import { useState } from 'react';
+import { Routes, Route } from 'react-router-dom';
+import { Page } from '@strapi/strapi/admin';
+import { Box, Flex, Typography, Button, Main } from '@strapi/design-system';
+import { ConfigTab } from '../../components/ConfigTab';
+import { ContentTypesTab } from '../../components/ContentTypesTab';
+import { SyncTab } from '../../components/SyncTab';
+import { LogsTab } from '../../components/LogsTab';
+import { HelpTab } from '../../components/HelpTab';
+import { SyncProfilesTab } from '../../components/SyncProfilesTab';
+import { MediaTab } from '../../components/MediaTab';
+
+const TABS = [
+    { key: 'config', label: 'Configuration' },
+    { key: 'content-types', label: 'Content Types' },
+    { key: 'sync-profiles', label: 'Sync Profiles' },
+    { key: 'sync', label: 'Sync' },
+    { key: 'media', label: 'Media' },
+    { key: 'logs', label: 'Logs' },
+    { key: 'help', label: 'Help' },
+];
+
+const HomePage = () => {
+    const [activeTab, setActiveTab] = useState('config');
+
+    return (
+        <Main>
+            <Box padding={8} background="neutral100">
+                <Typography variant="alpha" tag="h1">
+                    Content Sync Pro Plugin - Reliable Data Synchronization for Strapi Environments
+                </Typography>
+            
+
+                <Box paddingTop={4} paddingBottom={6}>
+                    <Flex gap={2}>
+                        {TABS.map((tab) => (
+                            <Button
+                                key={tab.key}
+                                variant={activeTab === tab.key ? 'default' : 'tertiary'}
+                                onClick={() => setActiveTab(tab.key)}
+                            >
+                                {tab.label}
+                            </Button>
+                        ))}
+                    </Flex>
+                </Box>
+
+                {activeTab === 'config' && <ConfigTab />}
+                {activeTab === 'content-types' && <ContentTypesTab />}
+                {activeTab === 'sync-profiles' && <SyncProfilesTab />}
+                {activeTab === 'sync' && <SyncTab />}
+                {activeTab === 'media' && <MediaTab />}
+                {activeTab === 'logs' && <LogsTab />}
+                {activeTab === 'help' && <HelpTab />}
+
+                <Box paddingTop={8} borderColor="neutral200" borderStyle="solid" borderWidth="1px 0 0 0">
+                    <Box paddingTop={4}>
+                        <Typography variant="sigma" textColor="neutral600">
+                            Need help with this plugin? Feel free to reach out or explore the resources below.
+                        </Typography>
+                        <Box paddingTop={2}>
+                            <Typography variant="pi" textColor="neutral500">
+                                Contact: {' Eja Arain '}
+                                <Typography
+                                    variant="pi"
+                                    textColor="primary600"
+                                    tag="a"
+                                    href="mailto:eharain@yahoo.com"
+                                >
+                                    eharain@yahoo.com
+                                </Typography>
+                                {' · '}
+                                <Typography
+                                    variant="pi"
+                                    textColor="primary600"
+                                    tag="a"
+                                    href="https://github.com/eharain/strapi-content-sync-pro"
+                                    target="_blank"
+                                    rel="noopener noreferrer"
+                                >
+                                    GitHub
+                                </Typography>
+                                {' · '}
+                                <Typography
+                                    variant="pi"
+                                    textColor="primary600"
+                                    tag="a"
+                                    href="https://www.linkedin.com/in/ejazarain/"
+                                    target="_blank"
+                                    rel="noopener noreferrer"
+                                >
+                                    LinkedIn
+                                </Typography>
+                            </Typography>
+                        </Box>
+                        <Box paddingTop={2}>
+                            <Typography variant="pi" textColor="neutral500">
+                                This plugin is a core component of {' '}
+                                <Typography
+                                    variant="pi"
+                                    textColor="primary600"
+                                    tag="a"
+                                    href="https://github.com/eharain/Rutba-ERP/"
+                                    target="_blank"
+                                    rel="noopener noreferrer"
+                                >
+                                    Rutba ERP
+                                </Typography>
+                                , powering reliable data synchronization across multi-environment installations.
+                            </Typography>
+                        </Box>
+                    </Box>
+                </Box>
+            </Box>
+        </Main>
+    );
+};
+
+const App = () => {
+    return (
+        <Routes>
+            <Route index element={<HomePage />} />
+            <Route path="*" element={<Page.Error />} />
+        </Routes>
+    );
+};
+
+export { App };
+export default App;

package/admin/src/pluginId.js

@@ -0,0 +1,3 @@
+const pluginId = 'strapi-content-sync-pro';
+
+export default pluginId;

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "strapi-content-sync-pro",
+  "version": "1.0.0",
+  "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": {
+    "name": "Ejaz Husain Arain",
+    "email": "eharain@yahoo.com",
+    "url": "https://github.com/eharain"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eharain/strapi-content-sync-pro.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eharain/strapi-content-sync-pro/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "homepage": "https://github.com/eharain/strapi-content-sync-pro#readme",
+  "keywords": [
+    "strapi",
+    "strapi-plugin",
+    "strapi-v5",
+    "sync",
+    "live-sync",
+    "data-sync",
+    "content-sync",
+    "copy",
+    "migrate",
+    "migration",
+    "mirror",
+    "replicate",
+    "replication",
+    "media-sync",
+    "synchronization",
+    "cross-environment",
+    "data-transfer",
+    "headless-cms",
+    "content-management"
+  ],
+  "exports": {
+    "./strapi-admin": {
+      "source": "./admin/src/index.js",
+      "import": "./admin/src/index.js",
+      "require": "./admin/src/index.js",
+      "default": "./admin/src/index.js"
+    },
+    "./strapi-server": {
+      "source": "./server/src/index.js",
+      "import": "./server/src/index.js",
+      "require": "./server/src/index.js",
+      "default": "./server/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "admin/",
+    "server/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "echo \"No tests yet\" && exit 0"
+  },
+  "peerDependencies": {
+    "@strapi/strapi": "^5.0.0",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0",
+    "react-router-dom": "^6.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=6.0.0"
+  },
+  "strapi": {
+    "name": "strapi-content-sync-pro",
+    "description": "Copy, migrate, and live-sync content, media, and data between Strapi environments",
+    "kind": "plugin",
+    "displayName": "Content Sync Pro"
+  }
+}

package/server/src/bootstrap.js

@@ -0,0 +1,151 @@
+'use strict';
+
+const { ensureSyncId } = require('./utils/sync-id');
+const { isRemoteUpdate } = require('./utils/sync-guard');
+
+const bootstrap = ({ strapi }) => {
+  /**
+   * Check if live sync is enabled for a content type
+   */
+  const isLiveSyncEnabled = async (contentTypeUid) => {
+    try {
+      const executionService = strapi.plugin('strapi-content-sync-pro').service('syncExecution');
+      const profilesService = strapi.plugin('strapi-content-sync-pro').service('syncProfiles');
+
+      // Get active profile for this content type
+      const profile = await profilesService.getActiveProfileForContentType(contentTypeUid);
+      if (!profile) return false;
+
+      // Get execution settings
+      const execSettings = await executionService.getProfileExecutionSettings(profile.id);
+
+      // Check if live mode is enabled
+      return execSettings.executionMode === 'live' && execSettings.enabled;
+    } catch (err) {
+      strapi.log.error(`[data-sync] Error checking live sync: ${err.message}`);
+      return false;
+    }
+  };
+
+  /**
+   * Execute live sync for a record
+   */
+  const executeLiveSync = async (contentTypeUid, record, action) => {
+    try {
+      const executionService = strapi.plugin('strapi-content-sync-pro').service('syncExecution');
+      const profilesService = strapi.plugin('strapi-content-sync-pro').service('syncProfiles');
+      const syncService = strapi.plugin('strapi-content-sync-pro').service('sync');
+      const logService = strapi.plugin('strapi-content-sync-pro').service('syncLog');
+
+      const profile = await profilesService.getActiveProfileForContentType(contentTypeUid);
+      if (!profile) return;
+
+      // Log the live sync trigger
+      await logService.log({
+        action: `live_${action}`,
+        contentType: contentTypeUid,
+        syncId: record.syncId,
+        direction: profile.direction,
+        status: 'info',
+        message: `Live sync triggered: ${action} on ${contentTypeUid}`,
+        details: { profileId: profile.id, recordId: record.id },
+      });
+
+      // Push the record based on profile direction
+      if (profile.direction === 'push' || profile.direction === 'both') {
+        await syncService.pushRecord(contentTypeUid, record);
+      }
+    } catch (err) {
+      strapi.log.error(`[data-sync] Live sync failed: ${err.message}`);
+    }
+  };
+
+  // Subscribe to DB lifecycle events for all content types
+  strapi.db.lifecycles.subscribe({
+    /**
+     * Automatically generate a syncId (UUID) for every new
+     * record in an api:: content type that does not already have one.
+     */
+    async beforeCreate(event) {
+      const { model, params } = event;
+      if (!model.uid.startsWith('api::')) return;
+
+      if (params.data) {
+        ensureSyncId(params.data);
+      }
+    },
+
+    /**
+     * After a local record is created, push it to the remote
+     * instance if live sync is enabled.
+     */
+    async afterCreate(event) {
+      const { model, result } = event;
+      if (!model.uid.startsWith('api::')) return;
+
+      const key = `${model.uid}:${result.syncId}`;
+      if (isRemoteUpdate(key)) return;
+
+      // Check if live sync is enabled
+      const liveEnabled = await isLiveSyncEnabled(model.uid);
+      if (!liveEnabled) return;
+
+      await executeLiveSync(model.uid, result, 'create');
+    },
+
+    /**
+     * After a local record is updated, push it to the remote
+     * instance if live sync is enabled.
+     */
+    async afterUpdate(event) {
+      const { model, result } = event;
+      if (!model.uid.startsWith('api::')) return;
+
+      const key = `${model.uid}:${result.syncId}`;
+      if (isRemoteUpdate(key)) return;
+
+      // Check if live sync is enabled
+      const liveEnabled = await isLiveSyncEnabled(model.uid);
+      if (!liveEnabled) return;
+
+      await executeLiveSync(model.uid, result, 'update');
+    },
+
+    /**
+     * After a local record is deleted, notify the remote
+     * instance if live sync is enabled.
+     */
+    async afterDelete(event) {
+      const { model, result } = event;
+      if (!model.uid.startsWith('api::')) return;
+      if (!result?.syncId) return;
+
+      const key = `${model.uid}:${result.syncId}`;
+      if (isRemoteUpdate(key)) return;
+
+      // Check if live sync is enabled
+      const liveEnabled = await isLiveSyncEnabled(model.uid);
+      if (!liveEnabled) return;
+
+      await executeLiveSync(model.uid, result, 'delete');
+    },
+  });
+
+  // Initialize scheduled syncs after Strapi is ready
+  strapi.server.use(async (ctx, next) => {
+    await next();
+  });
+
+  // Defer scheduler initialization
+  setImmediate(async () => {
+    try {
+      const executionService = strapi.plugin('strapi-content-sync-pro').service('syncExecution');
+      await executionService.initializeSchedulers();
+      strapi.log.info('[data-sync] Scheduled sync jobs initialized');
+    } catch (err) {
+      strapi.log.error(`[data-sync] Failed to initialize schedulers: ${err.message}`);
+    }
+  });
+};
+
+module.exports = bootstrap;

package/server/src/config/index.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+  default: {},
+};

package/server/src/content-types/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const syncLogSchema = require('./sync-log/schema.json');
+
+module.exports = {
+  'sync-log': { schema: syncLogSchema },
+};

package/server/src/content-types/sync-log/schema.json

@@ -0,0 +1,24 @@
+{
+  "kind": "collectionType",
+  "collectionName": "sync_logs",
+  "info": {
+    "singularName": "sync-log",
+    "pluralName": "sync-logs",
+    "displayName": "Sync Log"
+  },
+  "options": {},
+  "pluginOptions": {
+    "content-manager": { "visible": false },
+    "content-type-builder": { "visible": false }
+  },
+  "attributes": {
+    "action": { "type": "string" },
+    "contentType": { "type": "string" },
+    "recordId": { "type": "string" },
+    "syncId": { "type": "string" },
+    "direction": { "type": "string" },
+    "status": { "type": "string" },
+    "message": { "type": "text" },
+    "details": { "type": "json" }
+  }
+}

package/server/src/controllers/alerts.js

@@ -0,0 +1,59 @@
+'use strict';
+
+const PLUGIN_ID = 'strapi-content-sync-pro';
+
+module.exports = ({ strapi }) => ({
+  /**
+   * GET /alerts/settings
+   * Get alert settings
+   */
+  async getSettings(ctx) {
+    try {
+      const settings = await strapi.plugin(PLUGIN_ID).service('alerts').getSettings();
+      ctx.body = { data: settings };
+    } catch (err) {
+      ctx.throw(500, err.message);
+    }
+  },
+
+  /**
+   * PUT /alerts/settings
+   * Update alert settings
+   */
+  async updateSettings(ctx) {
+    const body = ctx.request.body;
+    try {
+      const settings = await strapi.plugin(PLUGIN_ID).service('alerts').updateSettings(body);
+      ctx.body = { data: settings };
+    } catch (err) {
+      ctx.throw(400, err.message);
+    }
+  },
+
+  /**
+   * POST /alerts/test/:channel
+   * Test an alert channel
+   */
+  async testChannel(ctx) {
+    const { channel } = ctx.params;
+    try {
+      const result = await strapi.plugin(PLUGIN_ID).service('alerts').testChannel(channel);
+      ctx.body = { data: result };
+    } catch (err) {
+      ctx.throw(400, err.message);
+    }
+  },
+
+  /**
+   * GET /alerts/stats
+   * Get alert statistics
+   */
+  async getStats(ctx) {
+    try {
+      const stats = strapi.plugin(PLUGIN_ID).service('alerts').getAlertStats();
+      ctx.body = { data: stats };
+    } catch (err) {
+      ctx.throw(500, err.message);
+    }
+  },
+});