@adminforth/rich-editor 1.0.8 → 1.0.10

package/index.ts

@@ -1,6 +1,9 @@
 
-import { IAdminForth, IHttpServer, AdminForthPlugin, AdminForthResource } from "adminforth";
-import { PluginOptions } from './types.js';
+import type { IAdminForth, IHttpServer, AdminForthResource, AdminUser, AfterSaveFunction } from "adminforth";
+import type { PluginOptions } from './types.js';
+import { AdminForthPlugin, Filters } from "adminforth";
+import * as cheerio from 'cheerio';
+
 
 // options:
 // attachments: {
@@ -12,10 +15,14 @@ import { PluginOptions } from './types.js';
 
 export default class RichEditorPlugin extends AdminForthPlugin {
   options: PluginOptions;
+  resourceConfig: AdminForthResource = undefined;
+
   uploadPlugin: AdminForthPlugin;
 
   activationOrder: number = 100000;
 
+  attachmentResource: AdminForthResource = undefined;
+  
   constructor(options: PluginOptions) {
     super(options, import.meta.url);
     this.options = options;
@@ -34,16 +41,23 @@ export default class RichEditorPlugin extends AdminForthPlugin {
       if (!resource) {
         throw new Error(`Resource '${this.options.attachments!.attachmentResource}' not found`);
       }
+      this.attachmentResource = resource;
       const field = resource.columns.find(c => c.name === this.options.attachments!.attachmentFieldName);
       if (!field) {
         throw new Error(`Field '${this.options.attachments!.attachmentFieldName}' not found in resource '${this.options.attachments!.attachmentResource}'`);
       }
       const plugin = adminforth.activatedPlugins.find(p => 
         p.resourceConfig!.resourceId === this.options.attachments!.attachmentResource && 
-        p.pluginOptions.pathColumnName === this.options.attachments!.attachmentFieldName);
+        p.pluginOptions.pathColumnName === this.options.attachments!.attachmentFieldName
+      );
       if (!plugin) {
         throw new Error(`Plugin for attachment field '${this.options.attachments!.attachmentFieldName}' not found in resource '${this.options.attachments!.attachmentResource}', please check if Upload Plugin is installed on the field ${this.options.attachments!.attachmentFieldName}`);
       }
+
+      if (plugin.pluginOptions.s3ACL !== 'public-read') {
+        throw new Error(`Upload Plugin for attachment field '${this.options.attachments!.attachmentFieldName}' in resource '${this.options.attachments!.attachmentResource}' 
+          should have s3ACL set to 'public-read' (in vast majority of cases signed urls inside of HTML text is not desired behavior, so we did not implement it)`);
+      }
       this.uploadPlugin = plugin;
     }
 
@@ -63,6 +77,130 @@ export default class RichEditorPlugin extends AdminForthPlugin {
     c.components.create = filed;
     c.components.edit = filed;
 
+    const editorRecordPkField = resourceConfig.columns.find(c => c.primaryKey);
+
+
+    // if attachment configured we need a post-save hook to create attachment records for each image data-s3path
+    if (this.options.attachments) {
+
+      function getAttachmentPathes(html: string) {
+        if (!html) {
+          return [];
+        }
+        const $ = cheerio.load(html);
+        const s3Paths = [];
+        $('img[data-s3path]').each((i, el) => {
+          const src = $(el).attr('data-s3path');
+          s3Paths.push(src);
+        });
+        return s3Paths;
+      }
+
+      const createAttachmentRecords = async (
+        adminforth: IAdminForth, options: PluginOptions, recordId: any, s3Paths: string[], adminUser: AdminUser
+      ) => {
+        process.env.HEAVY_DEBUG && console.log('📸 Creating attachment records', JSON.stringify(recordId))
+        await Promise.all(s3Paths.map(async (s3Path) => {
+          await adminforth.createResourceRecord(
+            {
+              resource: this.attachmentResource,
+              record: {
+                [options.attachments.attachmentFieldName]: s3Path,
+                [options.attachments.attachmentRecordIdFieldName]: recordId,
+                [options.attachments.attachmentResourceIdFieldName]: resourceConfig.resourceId,
+              },
+              adminUser
+            }
+          )
+        }
+        ));
+      }
+
+      const deleteAttachmentRecords = async (
+        adminforth: IAdminForth, options: PluginOptions, s3Paths: string[], adminUser: AdminUser
+      ) => {
+        
+        const attachmentPrimaryKeyField = this.attachmentResource.columns.find(c => c.primaryKey);
+        
+        const attachments = await adminforth.resource(options.attachments.attachmentResource).list(
+          Filters.IN(options.attachments.attachmentFieldName, s3Paths)
+        );
+
+        await Promise.all(attachments.map(async (a: any) => {
+          await adminforth.deleteResourceRecord(
+            {
+              resource: this.attachmentResource,
+              recordId: a[attachmentPrimaryKeyField.name],
+              adminUser,
+              record: a,
+            }
+          )
+        }))
+      }
+      
+
+      (resourceConfig.hooks.create.afterSave as Array<AfterSaveFunction>).push(async ({ record, adminUser }: { record: any, adminUser: AdminUser }) => {
+        // find all s3Paths in the html
+        const s3Paths = getAttachmentPathes(record[this.options.htmlFieldName])
+        
+        process.env.HEAVY_DEBUG && console.log('📸 Found s3Paths', s3Paths);
+
+        // create attachment records
+        await createAttachmentRecords(
+          adminforth, this.options, record[editorRecordPkField.name], s3Paths, adminUser);
+
+        return { ok: true };
+      });
+
+      // after edit we need to delete attachments that are not in the html anymore
+      // and add new ones
+      (resourceConfig.hooks.edit.afterSave as Array<AfterSaveFunction>).push(
+        async ({ recordId, record, adminUser }: { recordId: any, record: any, adminUser: AdminUser }) => {
+          process.env.HEAVY_DEBUG && console.log('⚓ Cought hook', recordId, 'rec', record);
+          if (record[this.options.htmlFieldName] === undefined) {
+            // field was not changed, do nothing
+            return { ok: true };
+          }
+          const existingApparts = await adminforth.resource(this.options.attachments.attachmentResource).list([
+            Filters.EQ(this.options.attachments.attachmentRecordIdFieldName, recordId),
+            Filters.EQ(this.options.attachments.attachmentResourceIdFieldName, resourceConfig.resourceId)
+          ]);
+          const existingS3Paths = existingApparts.map((a: any) => a[this.options.attachments.attachmentFieldName]);
+          const newS3Paths = getAttachmentPathes(record[this.options.htmlFieldName]);
+          process.env.HEAVY_DEBUG && console.log('📸 Existing s3Paths (from db)', existingS3Paths)
+          process.env.HEAVY_DEBUG && console.log('📸 Found new s3Paths (from text)', newS3Paths);
+          const toDelete = existingS3Paths.filter(s3Path => !newS3Paths.includes(s3Path));
+          const toAdd = newS3Paths.filter(s3Path => !existingS3Paths.includes(s3Path));
+          process.env.HEAVY_DEBUG && console.log('📸 Found s3Paths to delete', toDelete)
+          process.env.HEAVY_DEBUG && console.log('📸 Found s3Paths to add', toAdd);
+
+          await Promise.all([
+            deleteAttachmentRecords(adminforth, this.options, toDelete, adminUser),
+            createAttachmentRecords(adminforth, this.options, recordId, toAdd, adminUser)
+          ]);
+
+          return { ok: true };
+
+        }
+      );
+
+      // after delete we need to delete all attachments
+      (resourceConfig.hooks.delete.afterSave as Array<AfterSaveFunction>).push(
+        async ({ record, adminUser }: { record: any, adminUser: AdminUser }) => {
+          const existingApparts = await adminforth.resource(this.options.attachments.attachmentResource).list(
+            [
+              Filters.EQ(this.options.attachments.attachmentRecordIdFieldName, record[editorRecordPkField.name]),
+              Filters.EQ(this.options.attachments.attachmentResourceIdFieldName, resourceConfig.resourceId)
+            ]
+          );
+          const existingS3Paths = existingApparts.map((a: any) => a[this.options.attachments.attachmentFieldName]);
+          process.env.HEAVY_DEBUG && console.log('📸 Found s3Paths to delete', existingS3Paths);
+          await deleteAttachmentRecords(adminforth, this.options, existingS3Paths, adminUser);
+
+          return { ok: true };
+        }
+    );
+    }
   }
   
   validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
@@ -71,7 +209,6 @@ export default class RichEditorPlugin extends AdminForthPlugin {
       throw new Error(`Invalid provider ${this.options.completion.provider}`);
     }
 
-
   }
 
   instanceUniqueRepresentation(pluginOptions: any) : string {
@@ -194,7 +331,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
         };
       }
     });
-  }
 
+  }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/rich-editor",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -11,5 +11,8 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "dependencies": {
+    "cheerio": "^1.0.0"
+  }
 }

package/types.ts

@@ -149,20 +149,24 @@ export interface PluginOptions {
      * Field name in the attachment resource where image is stored. Should point to the existing field in the attachment resource.
      * Also there should be upload plugin installed on this field.
      */
-    attachmentFieldName: 'image_path',
+    attachmentFieldName: string; // e.g. 'image_path',
 
     /**
-     * When attachment is created, it will be linked to the record with this field name.
-     * For example when RichEditor installed on description field of appartment resource,
-     * field in attachment resource describet hear will store id of appartment record.
+     * When attachment is created, it will be linked to the record, by storing id of the record with editor in attachment resource.
+     * Here you define the field name where this id will be stored.
+     * 
+     * Linking is needed to remove all attachments when record is deleted.
+     * 
+     * For example when RichEditor installed on description field of apartment resource,
+     * field in attachment resource described hear will store id of apartment record.
      */
-    attachmentRecordIdFieldName: 'record_id',
+    attachmentRecordIdFieldName: string; // e.g. 'apartment_id',
 
     /**
-     * When attachment is created, it will be linked to the resource with this field name.
-     * For example when RichEditor installed on description field of appartment resource, it will store id of appartment resource.
+     * When attachment is created, it will be linked to the resource, by storing id of the resource with editor in attachment resource.
+     * For example when RichEditor installed on description field of apartment resource, it will store id of apartment resource.
      */
-    attachmentResourceIdFieldName: 'resource_id',
+    attachmentResourceIdFieldName: string; // e.g. 'apartment_resource_id',
   },
 }
 

package/dist/async-queue.ts

@@ -1,31 +0,0 @@
-
-
-export default class AsyncQueue {
-  queue: (() => Promise<any>)[];
-  processing: boolean;
-
-  constructor() {
-    this.queue = [];
-    this.processing = false;
-  }
-
-  async add(task: () => Promise<any>) {
-    this.queue.push(task);
-    if (!this.processing) {
-      this.process();
-    }
-  }
-
-  async process() {
-    this.processing = true;
-    while (this.queue.length > 0) {
-      const task = this.queue.shift()!;
-      try {
-        await task();
-      } catch (error) {
-        console.error('Task encountered an error:', error);
-      }
-    }
-    this.processing = false;
-  }
-}

package/dist/custom/node_modules/.package-lock.json

@@ -1,65 +0,0 @@
-{
-  "name": "custom",
-  "version": "1.0.0",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "node_modules/eventemitter3": {
-      "version": "5.0.1",
-      "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz",
-      "integrity": "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA=="
-    },
-    "node_modules/fast-diff": {
-      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz",
-      "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw=="
-    },
-    "node_modules/lodash-es": {
-      "version": "4.17.21",
-      "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz",
-      "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw=="
-    },
-    "node_modules/lodash.clonedeep": {
-      "version": "4.5.0",
-      "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz",
-      "integrity": "sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ=="
-    },
-    "node_modules/lodash.isequal": {
-      "version": "4.5.0",
-      "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
-      "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ=="
-    },
-    "node_modules/parchment": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/parchment/-/parchment-3.0.0.tgz",
-      "integrity": "sha512-HUrJFQ/StvgmXRcQ1ftY6VEZUq3jA2t9ncFN4F84J/vN0/FPpQF+8FKXb3l6fLces6q0uOHj6NJn+2xvZnxO6A=="
-    },
-    "node_modules/quill": {
-      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/quill/-/quill-2.0.2.tgz",
-      "integrity": "sha512-QfazNrhMakEdRG57IoYFwffUIr04LWJxbS/ZkidRFXYCQt63c1gK6Z7IHUXMx/Vh25WgPBU42oBaNzQ0K1R/xw==",
-      "dependencies": {
-        "eventemitter3": "^5.0.1",
-        "lodash-es": "^4.17.21",
-        "parchment": "^3.0.0",
-        "quill-delta": "^5.1.0"
-      },
-      "engines": {
-        "npm": ">=8.2.3"
-      }
-    },
-    "node_modules/quill-delta": {
-      "version": "5.1.0",
-      "resolved": "https://registry.npmjs.org/quill-delta/-/quill-delta-5.1.0.tgz",
-      "integrity": "sha512-X74oCeRI4/p0ucjb5Ma8adTXd9Scumz367kkMK5V/IatcX6A0vlgLgKbzXWy5nZmCGeNJm2oQX0d2Eqj+ZIlCA==",
-      "dependencies": {
-        "fast-diff": "^1.3.0",
-        "lodash.clonedeep": "^4.5.0",
-        "lodash.isequal": "^4.5.0"
-      },
-      "engines": {
-        "node": ">= 12.0.0"
-      }
-    }
-  }
-}

package/dist/custom/node_modules/eventemitter3/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Arnout Kazemier
-
-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/custom/node_modules/eventemitter3/README.md

@@ -1,94 +0,0 @@
-# EventEmitter3
-
-[![Version npm](https://img.shields.io/npm/v/eventemitter3.svg?style=flat-square)](https://www.npmjs.com/package/eventemitter3)[![CI](https://img.shields.io/github/actions/workflow/status/primus/eventemitter3/ci.yml?branch=master&label=CI&style=flat-square)](https://github.com/primus/eventemitter3/actions?query=workflow%3ACI+branch%3Amaster)[![Coverage Status](https://img.shields.io/coveralls/primus/eventemitter3/master.svg?style=flat-square)](https://coveralls.io/r/primus/eventemitter3?branch=master)
-
-[![Sauce Test Status](https://saucelabs.com/browser-matrix/eventemitter3.svg)](https://saucelabs.com/u/eventemitter3)
-
-EventEmitter3 is a high performance EventEmitter. It has been micro-optimized
-for various of code paths making this, one of, if not the fastest EventEmitter
-available for Node.js and browsers. The module is API compatible with the
-EventEmitter that ships by default with Node.js but there are some slight
-differences:
-
-- Domain support has been removed.
-- We do not `throw` an error when you emit an `error` event and nobody is
-  listening.
-- The `newListener` and `removeListener` events have been removed as they
-  are useful only in some uncommon use-cases.
-- The `setMaxListeners`, `getMaxListeners`, `prependListener` and
-  `prependOnceListener` methods are not available.
-- Support for custom context for events so there is no need to use `fn.bind`.
-- The `removeListener` method removes all matching listeners, not only the
-  first.
-
-It's a drop in replacement for existing EventEmitters, but just faster. Free
-performance, who wouldn't want that? The EventEmitter is written in EcmaScript 3
-so it will work in the oldest browsers and node versions that you need to
-support.
-
-## Installation
-
-```bash
-$ npm install --save eventemitter3
-```
-
-## CDN
-
-Recommended CDN:
-
-```text
-https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js
-```
-
-## Usage
-
-After installation the only thing you need to do is require the module:
-
-```js
-var EventEmitter = require('eventemitter3');
-```
-
-And you're ready to create your own EventEmitter instances. For the API
-documentation, please follow the official Node.js documentation:
-
-http://nodejs.org/api/events.html
-
-### Contextual emits
-
-We've upgraded the API of the `EventEmitter.on`, `EventEmitter.once` and
-`EventEmitter.removeListener` to accept an extra argument which is the `context`
-or `this` value that should be set for the emitted events. This means you no
-longer have the overhead of an event that required `fn.bind` in order to get a
-custom `this` value.
-
-```js
-var EE = new EventEmitter()
-  , context = { foo: 'bar' };
-
-function emitted() {
-  console.log(this === context); // true
-}
-
-EE.once('event-name', emitted, context);
-EE.on('another-event', emitted, context);
-EE.removeListener('another-event', emitted, context);
-```
-
-### Tests and benchmarks
-
-This module is well tested. You can run:
-
-- `npm test` to run the tests under Node.js.
-- `npm run test-browser` to run the tests in real browsers via Sauce Labs.
-
-We also have a set of benchmarks to compare EventEmitter3 with some available
-alternatives. To run the benchmarks run `npm run benchmark`.
-
-Tests and benchmarks are not included in the npm package. If you want to play
-with them you have to clone the GitHub repository.
-Note that you will have to run an additional `npm i` in the benchmarks folder
-before `npm run benchmark`.
-
-## License
-
-[MIT](LICENSE)