@zenith-open/zenithcms-plugin-algolia 1.0.0-beta.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aman T Shekar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { ZenithPlugin } from '@zenith-open/zenithcms-types';
+export declare const algoliaSearchMatrix: ZenithPlugin;
+export default algoliaSearchMatrix;

package/dist/index.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.algoliaSearchMatrix = void 0;
+const algoliasearch_1 = require("algoliasearch");
+exports.algoliaSearchMatrix = {
+    id: 'algolia-search-matrix',
+    name: 'Algolia Search Matrix',
+    version: '1.0.0',
+    description: 'Automatically indexes newly published content collections to Algolia indexes for instantaneous keyword discovery.',
+    author: 'Zenith Plugin',
+    configSchema: {
+        appId: {
+            type: 'string',
+            label: 'Algolia Application ID',
+            required: true,
+        },
+        adminKey: {
+            type: 'secret',
+            label: 'Algolia Admin API Key',
+            description: 'Used to write and delete records in your Algolia indexes.',
+            required: true,
+        },
+        indexPrefix: {
+            type: 'string',
+            label: 'Index Prefix',
+            description: 'Prefix for Algolia indexes (e.g. "prod_")',
+        },
+        syncAllPublic: {
+            type: 'boolean',
+            label: 'Sync All Public Collections',
+            description: 'Automatically sync all collections that have publicRead enabled',
+            default: true,
+        },
+    },
+    apply: (config) => config,
+    onInit: (ctx) => {
+        const pluginConfig = ctx.config.plugins?.find((p) => p.id === 'algolia-search-matrix' || p.name === 'Algolia Search Matrix')?.config || {};
+        const { appId, adminKey, indexPrefix, syncAllPublic } = pluginConfig;
+        if (!appId || !adminKey) {
+            ctx.logger.warn('Missing App ID or Admin Key. Algolia sync is disabled.');
+            return;
+        }
+        const client = (0, algoliasearch_1.algoliasearch)(appId, adminKey);
+        const prefix = indexPrefix || '';
+        const syncAll = syncAllPublic !== false;
+        const shouldSyncCollection = (collection) => {
+            const explicitSync = collection.algoliaSync;
+            if (explicitSync === false)
+                return false;
+            if (explicitSync === true)
+                return true;
+            return syncAll && collection.publicRead === true;
+        };
+        ctx.config.collections.forEach((collection) => {
+            if (!shouldSyncCollection(collection))
+                return;
+            const indexName = `${prefix}${collection.slug}`;
+            ctx.hooks.on(`collection:${collection.slug}:afterCreate`, async (payload) => {
+                try {
+                    const doc = payload.doc;
+                    if (doc._status && doc._status !== 'published')
+                        return payload;
+                    const objectID = String(doc.id || doc._id);
+                    await client.saveObject({
+                        indexName,
+                        body: {
+                            ...doc,
+                            objectID,
+                        },
+                    });
+                    ctx.logger.debug(`Synced document ${objectID} to ${indexName}`);
+                }
+                catch (error) {
+                    const message = error instanceof Error ? error.message : String(error);
+                    ctx.logger.error('Failed to sync document on create', { err: message });
+                }
+                return payload;
+            });
+            ctx.hooks.on(`collection:${collection.slug}:afterUpdate`, async (payload) => {
+                try {
+                    const doc = payload.doc;
+                    const objectID = String(doc.id || doc._id);
+                    if (doc._status && doc._status !== 'published') {
+                        await client.deleteObject({ indexName, objectID });
+                        ctx.logger.debug(`Removed unpublished document ${objectID} from ${indexName}`);
+                        return payload;
+                    }
+                    await client.partialUpdateObject({
+                        indexName,
+                        objectID,
+                        createIfNotExists: true,
+                        attributesToUpdate: doc,
+                    });
+                    ctx.logger.debug(`Updated document ${objectID} in ${indexName}`);
+                }
+                catch (error) {
+                    const message = error instanceof Error ? error.message : String(error);
+                    ctx.logger.error('Failed to sync document on update', { err: message });
+                }
+                return payload;
+            });
+            ctx.hooks.on(`collection:${collection.slug}:afterDelete`, async (payload) => {
+                try {
+                    await client.deleteObject({ indexName, objectID: String(payload.id) });
+                    ctx.logger.debug(`Deleted document ${payload.id} from ${indexName}`);
+                }
+                catch (error) {
+                    const message = error instanceof Error ? error.message : String(error);
+                    ctx.logger.error('Failed to delete document', { err: message });
+                }
+                return payload;
+            });
+        });
+        ctx.logger.info('Algolia Search Matrix initialized and hooks attached.');
+    },
+};
+exports.default = exports.algoliaSearchMatrix;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@zenith-open/zenithcms-plugin-algolia",
+  "version": "1.0.0-beta.10",
+  "description": "Algolia search indexing plugin for Zenith CMS",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "algoliasearch": "5.55.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@zenith-open/zenithcms-types": "1.0.0-beta.10",
+    "@zenith-open/zenithcms-core": "1.0.0-beta.10"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc"
+  }
+}