@zenith-open/zenithcms-plugin-cloudinary 1.0.0

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,7 @@
+import { ZenithPlugin } from '@zenith-open/zenithcms-types';
+export interface CloudinaryConfig {
+    cloudName?: string;
+    apiKey?: string;
+    apiSecret?: string;
+}
+export declare const cloudinaryPlugin: (config?: CloudinaryConfig) => ZenithPlugin;

package/dist/index.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cloudinaryPlugin = void 0;
+const cloudinary_1 = require("cloudinary");
+const cloudinaryPlugin = (config) => {
+    return {
+        id: 'cloudinary-storage',
+        name: 'Cloudinary Storage',
+        description: 'Handles media uploads and delivery via Cloudinary.',
+        apply: () => { },
+        onReady: async (ctx) => {
+            const resolveConfig = async (overrideSettings, siteId) => {
+                const activeConfig = {
+                    cloudName: process.env.CLOUDINARY_CLOUD_NAME || config?.cloudName,
+                    apiKey: process.env.CLOUDINARY_API_KEY || config?.apiKey,
+                    apiSecret: process.env.CLOUDINARY_API_SECRET || config?.apiSecret
+                };
+                if (overrideSettings) {
+                    if (overrideSettings.cloudinaryCloudName)
+                        activeConfig.cloudName = overrideSettings.cloudinaryCloudName;
+                    if (overrideSettings.cloudinaryApiKey)
+                        activeConfig.apiKey = overrideSettings.cloudinaryApiKey;
+                    if (overrideSettings.cloudinaryApiSecret && overrideSettings.cloudinaryApiSecret !== '[MASKED_CREDENTIAL]')
+                        activeConfig.apiSecret = overrideSettings.cloudinaryApiSecret;
+                    return activeConfig;
+                }
+                try {
+                    const adapter = ctx.adapter;
+                    if (adapter && adapter.findOne) {
+                        const query = siteId ? { siteId } : {};
+                        const settings = await adapter.findOne('z_settings', query);
+                        if (settings) {
+                            if (settings.cloudinaryCloudName)
+                                activeConfig.cloudName = settings.cloudinaryCloudName;
+                            if (settings.cloudinaryApiKey)
+                                activeConfig.apiKey = settings.cloudinaryApiKey;
+                            if (settings.cloudinaryApiSecret && settings.cloudinaryApiSecret !== '[MASKED_CREDENTIAL]')
+                                activeConfig.apiSecret = settings.cloudinaryApiSecret;
+                        }
+                    }
+                }
+                catch (e) {
+                    ctx.logger.warn('[Cloudinary Plugin] Failed to load config from database settings');
+                }
+                return activeConfig;
+            };
+            const mediaAdapter = {
+                async testConnection(overrideSettings, siteId) {
+                    const activeConfig = await resolveConfig(overrideSettings, siteId);
+                    if (!activeConfig.cloudName || !activeConfig.apiKey || !activeConfig.apiSecret) {
+                        throw new Error('Cloudinary credentials missing');
+                    }
+                    cloudinary_1.v2.config({
+                        cloud_name: activeConfig.cloudName,
+                        api_key: activeConfig.apiKey,
+                        api_secret: activeConfig.apiSecret
+                    });
+                    const result = await cloudinary_1.v2.api.ping();
+                    return result.status === 'ok';
+                },
+                async uploadFile(fileInput, options = {}) {
+                    const activeConfig = await resolveConfig(undefined, options.siteId);
+                    if (!activeConfig.cloudName || !activeConfig.apiKey || !activeConfig.apiSecret) {
+                        throw new Error('Cloudinary service is not configured');
+                    }
+                    cloudinary_1.v2.config({
+                        cloud_name: activeConfig.cloudName,
+                        api_key: activeConfig.apiKey,
+                        api_secret: activeConfig.apiSecret
+                    });
+                    const sanitizedFilename = options.filename
+                        ? options.filename.replace(/[^a-zA-Z0-9.-]/g, '-')
+                        : undefined;
+                    const uploadOptions = {
+                        folder: options.folder || 'zenithcms',
+                        public_id: sanitizedFilename ? `${Date.now()}-${sanitizedFilename}` : undefined,
+                        resource_type: 'auto',
+                    };
+                    if (typeof fileInput === 'string') {
+                        return await cloudinary_1.v2.uploader.upload(fileInput, uploadOptions);
+                    }
+                    else {
+                        return new Promise((resolve, reject) => {
+                            const stream = cloudinary_1.v2.uploader.upload_stream(uploadOptions, (error, result) => {
+                                if (error || !result)
+                                    return reject(error || new Error('Upload failed'));
+                                resolve(result);
+                            });
+                            stream.end(fileInput);
+                        });
+                    }
+                },
+                async deleteFile(publicId, options = {}) {
+                    const activeConfig = await resolveConfig(undefined, options.siteId);
+                    if (!activeConfig.cloudName || !activeConfig.apiKey || !activeConfig.apiSecret) {
+                        ctx.logger.warn('[Cloudinary Plugin] Skipping file deletion: credentials missing');
+                        return;
+                    }
+                    cloudinary_1.v2.config({
+                        cloud_name: activeConfig.cloudName,
+                        api_key: activeConfig.apiKey,
+                        api_secret: activeConfig.apiSecret
+                    });
+                    await cloudinary_1.v2.uploader.destroy(publicId);
+                }
+            };
+            // @ts-ignore - Dynamically registering to core MediaService if it's available via global or injection
+            // The Zenith engine uses global registry for media adapters
+            const core = require('@zenith-open/zenithcms-core');
+            if (core && core.MediaService) {
+                core.MediaService.registerAdapter(mediaAdapter);
+                ctx.logger.info('[Cloudinary Plugin] Successfully registered with Core MediaService.');
+            }
+            else {
+                ctx.logger.error('[Cloudinary Plugin] Could not find core MediaService to register.');
+            }
+        }
+    };
+};
+exports.cloudinaryPlugin = cloudinaryPlugin;

package/package.json

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