@adminforth/rich-editor 1.0.16 → 1.0.18

package/ChangeLog.md

@@ -1,5 +1,17 @@
+## [1.0.18] - 2024-12-26
 
+### Improved
+
+- COmpatibility with latest AdminForth, remove dependency of hook types
+
+## [1.0.17] - 2024-12-06
+
+### Added
+
+- Reworked completion for adapter
 
 ## [1.0.12] - 2021-10-07
+
 ### Added
+
 - Rate limiting for openai requests support

package/custom/quillEditor.vue

@@ -1,5 +1,4 @@
 <template>
-
   <div 
     class="bg-gray-50 border border-gray-300 text-gray-900 text-sm rounded-lg focus:ring-blue-500 
       focus:border-blue-500 block w-full p-2.5 dark:bg-gray-700 dark:border-gray-600 dark:placeholder-gray-400
@@ -200,6 +199,7 @@ onMounted(() => {
 
   quill = new Quill(editor.value as HTMLElement, {
     theme: "snow",
+    readOnly:props.column?.editReadonly,
     placeholder: 'Type here...',
     // formats : ['complete'],
     modules: {
@@ -431,7 +431,7 @@ function approveCompletion(type: 'all' | 'word') {
 }
 
 async function startCompletion() {
-  if (!props.meta.shouldComplete) {
+  if (!props.meta.shouldComplete || props.column?.editReadonly ) {
     return;
   }
   completion.value = null;

package/dist/custom/quillEditor.vue

@@ -1,5 +1,4 @@
 <template>
-
   <div 
     class="bg-gray-50 border border-gray-300 text-gray-900 text-sm rounded-lg focus:ring-blue-500 
       focus:border-blue-500 block w-full p-2.5 dark:bg-gray-700 dark:border-gray-600 dark:placeholder-gray-400
@@ -200,6 +199,7 @@ onMounted(() => {
 
   quill = new Quill(editor.value as HTMLElement, {
     theme: "snow",
+    readOnly:props.column?.editReadonly,
     placeholder: 'Type here...',
     // formats : ['complete'],
     modules: {
@@ -431,7 +431,7 @@ function approveCompletion(type: 'all' | 'word') {
 }
 
 async function startCompletion() {
-  if (!props.meta.shouldComplete) {
+  if (!props.meta.shouldComplete || props.column?.editReadonly ) {
     return;
   }
   completion.value = null;

package/dist/index.js

@@ -112,7 +112,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
                         });
                     })));
                 });
-                resourceConfig.hooks.create.afterSave.push((_d) => __awaiter(this, [_d], void 0, function* ({ record, adminUser }) {
+                (resourceConfig.hooks.create.afterSave).push((_d) => __awaiter(this, [_d], void 0, function* ({ record, adminUser }) {
                     // find all s3Paths in the html
                     const s3Paths = getAttachmentPathes(record[this.options.htmlFieldName]);
                     process.env.HEAVY_DEBUG && console.log('📸 Found s3Paths', s3Paths);
@@ -122,7 +122,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
                 }));
                 // after edit we need to delete attachments that are not in the html anymore
                 // and add new ones
-                resourceConfig.hooks.edit.afterSave.push((_e) => __awaiter(this, [_e], void 0, function* ({ recordId, record, adminUser }) {
+                (resourceConfig.hooks.edit.afterSave).push((_e) => __awaiter(this, [_e], void 0, function* ({ recordId, record, adminUser }) {
                     process.env.HEAVY_DEBUG && console.log('⚓ Cought hook', recordId, 'rec', record);
                     if (record[this.options.htmlFieldName] === undefined) {
                         // field was not changed, do nothing
@@ -147,7 +147,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
                     return { ok: true };
                 }));
                 // after delete we need to delete all attachments
-                resourceConfig.hooks.delete.afterSave.push((_f) => __awaiter(this, [_f], void 0, function* ({ record, adminUser }) {
+                (resourceConfig.hooks.delete.afterSave).push((_f) => __awaiter(this, [_f], void 0, function* ({ record, adminUser }) {
                     const existingAparts = yield adminforth.resource(this.options.attachments.attachmentResource).list([
                         Filters.EQ(this.options.attachments.attachmentRecordIdFieldName, record[editorRecordPkField.name]),
                         Filters.EQ(this.options.attachments.attachmentResourceIdFieldName, resourceConfig.resourceId)
@@ -161,10 +161,14 @@ export default class RichEditorPlugin extends AdminForthPlugin {
         });
     }
     validateConfigAfterDiscover(adminforth, resourceConfig) {
+        var _a, _b;
         this.adminforth = adminforth;
+        if ((_a = this.options.completion) === null || _a === void 0 ? void 0 : _a.adapter) {
+            (_b = this.options.completion) === null || _b === void 0 ? void 0 : _b.adapter.validate();
+        }
         // optional method where you can safely check field types after database discovery was performed
-        if (this.options.completion && this.options.completion.provider !== 'openai-chat-gpt') {
-            throw new Error(`Invalid provider ${this.options.completion.provider}`);
+        if (this.options.completion && !this.options.completion.adapter) {
+            throw new Error(`Completion adapter is required`);
         }
     }
     instanceUniqueRepresentation(pluginOptions) {
@@ -206,7 +210,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/doComplete`,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, headers }) {
-                var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+                var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
                 const { record } = body;
                 if ((_b = this.options.completion.rateLimit) === null || _b === void 0 ? void 0 : _b.limit) {
                     // rate limit
@@ -239,28 +243,9 @@ export default class RichEditorPlugin extends AdminForthPlugin {
                         "Be short, clear and precise. No quotes. Don't talk to me. Just write text\n";
                 }
                 process.env.HEAVY_DEBUG && console.log('🪲 OpenAI Prompt 🧠', content);
-                const stop = ((_l = this.options.completion.expert) === null || _l === void 0 ? void 0 : _l.stop) || ['.'];
-                const resp = yield fetch('https://api.openai.com/v1/chat/completions', {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                        'Authorization': `Bearer ${this.options.completion.params.apiKey}`
-                    },
-                    body: JSON.stringify({
-                        model: this.options.completion.params.model || 'gpt-4o-mini',
-                        messages: [
-                            {
-                                role: 'user',
-                                content,
-                            }
-                        ],
-                        temperature: ((_m = this.options.completion.expert) === null || _m === void 0 ? void 0 : _m.temperature) || 0.7,
-                        max_tokens: ((_o = this.options.completion.expert) === null || _o === void 0 ? void 0 : _o.maxTokens) || 50,
-                        stop,
-                    })
-                });
-                const data = yield resp.json();
-                let suggestion = data.choices[0].message.content + (data.choices[0].finish_reason === 'stop' ? (stop[0] === '.' && stop.length === 1 ? '. ' : '') : '');
+                const { content: respContent, finishReason } = yield this.options.completion.adapter.complete(content, (_m = (_l = this.options.completion) === null || _l === void 0 ? void 0 : _l.expert) === null || _m === void 0 ? void 0 : _m.stop, (_p = (_o = this.options.completion) === null || _o === void 0 ? void 0 : _o.expert) === null || _p === void 0 ? void 0 : _p.maxTokens);
+                const stop = ((_q = this.options.completion.expert) === null || _q === void 0 ? void 0 : _q.stop) || ['.'];
+                let suggestion = respContent + (finishReason === 'stop' ? (stop[0] === '.' && stop.length === 1 ? '. ' : '') : '');
                 if (suggestion.startsWith(currentVal)) {
                     suggestion = suggestion.slice(currentVal.length);
                 }

package/dist/types.js

@@ -1,15 +1 @@
-// example options ussage:
-//{
-//  htmlFieldName: 'description',
-//  completion: {
-//    provider: 'openai-chat-gpt',
-//    params: {
-//      apiKey: process.env.OPENAI_API_KEY as string,
-//      model: 'gpt-4o',
-//    },
-//    expert: {
-//      debounceTime: 250,
-//    }
-//  }
-//}
 export {};

package/index.ts

@@ -1,5 +1,5 @@
 
-import type { IAdminForth, IHttpServer, AdminForthResource, AdminUser, AfterSaveFunction } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResource, AdminUser } from "adminforth";
 import type { PluginOptions } from './types.js';
 import { AdminForthPlugin, Filters, RateLimiter } from "adminforth";
 import * as cheerio from 'cheerio';
@@ -142,7 +142,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
       }
       
 
-      (resourceConfig.hooks.create.afterSave as Array<AfterSaveFunction>).push(async ({ record, adminUser }: { record: any, adminUser: AdminUser }) => {
+      (resourceConfig.hooks.create.afterSave).push(async ({ record, adminUser }: { record: any, adminUser: AdminUser }) => {
         // find all s3Paths in the html
         const s3Paths = getAttachmentPathes(record[this.options.htmlFieldName])
         
@@ -157,7 +157,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
 
       // 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(
+      (resourceConfig.hooks.edit.afterSave).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) {
@@ -188,7 +188,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
       );
 
       // after delete we need to delete all attachments
-      (resourceConfig.hooks.delete.afterSave as Array<AfterSaveFunction>).push(
+      (resourceConfig.hooks.delete.afterSave).push(
         async ({ record, adminUser }: { record: any, adminUser: AdminUser }) => {
           const existingAparts = await adminforth.resource(this.options.attachments.attachmentResource).list(
             [
@@ -202,15 +202,18 @@ export default class RichEditorPlugin extends AdminForthPlugin {
 
           return { ok: true };
         }
-    );
+      );
     }
   }
   
   validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
     this.adminforth = adminforth;
+    if (this.options.completion?.adapter) {
+      this.options.completion?.adapter.validate();
+    }
     // optional method where you can safely check field types after database discovery was performed
-    if (this.options.completion && this.options.completion.provider !== 'openai-chat-gpt') {
-      throw new Error(`Invalid provider ${this.options.completion.provider}`);
+    if (this.options.completion && !this.options.completion.adapter) {
+      throw new Error(`Completion adapter is required`);
     }
 
   }
@@ -310,29 +313,10 @@ export default class RichEditorPlugin extends AdminForthPlugin {
         }
 
         process.env.HEAVY_DEBUG && console.log('🪲 OpenAI Prompt 🧠', content);
+        const { content: respContent, finishReason } = await this.options.completion.adapter.complete(content, this.options.completion?.expert?.stop, this.options.completion?.expert?.maxTokens);
         const stop = this.options.completion.expert?.stop || ['.'];
-        const resp = await fetch('https://api.openai.com/v1/chat/completions', {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-            'Authorization': `Bearer ${this.options.completion.params.apiKey}`
-          },
-          body: JSON.stringify({
-            model: this.options.completion.params.model || 'gpt-4o-mini',
-            messages: [
-              {
-                role: 'user', 
-                content,
-              }
-            ],
-            temperature: this.options.completion.expert?.temperature || 0.7,
-            max_tokens: this.options.completion.expert?.maxTokens || 50,
-            stop,
-          })
-        });
-        const data = await resp.json();
-        let suggestion = data.choices[0].message.content + (
-          data.choices[0].finish_reason === 'stop' ? (
+        let suggestion = respContent + (
+          finishReason === 'stop' ? (
             stop[0] === '.' && stop.length === 1 ? '. ' : ''
           ) : ''
         );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/rich-editor",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/types.ts

@@ -1,3 +1,5 @@
+import { CompletionAdapter } from "adminforth";
+
 // example options ussage:
 //{
 //  htmlFieldName: 'description',
@@ -52,27 +54,10 @@ export interface PluginOptions {
    */
   completion?: {
     /**
-     * The provider is the name of the plugin that will be used to provide completions.
-     */
-    provider: string;
-
-    /**
-     * The params are the parameters that will be passed to the completion provider.
+     * Adapter for completion.
      */
-    params: {
-      /**
-       * OpenAI API key. Go to https://platform.openai.com/, go to Dashboard -> API keys -> Create new secret key
-       * Paste value in your .env file OPENAI_API_KEY=your_key
-       * Set openAiApiKey: process.env.OPENAI_API_KEY to access it
-       */
-      apiKey: string;
 
-      /**
-       * Model name. Go to https://platform.openai.com/docs/models, select model and copy name.
-       * Default is `gpt-4o-mini`. Use e.g. more expensive `gpt-4o` for more powerful model.
-       */
-      model?: string;
-    }
+    adapter: CompletionAdapter;
 
     /**
      * Expert settings
@@ -83,11 +68,6 @@ export interface PluginOptions {
          */
         maxTokens?: number;
 
-        /**
-         * Temperature (0-1). Lower is more deterministic, higher is more unpredicted creative. Default is 0.7.
-         */
-        temperature?: number;
-
         /**
          * Maximum number of last characters which will be used for completion for target field. Default is 500.
          * Higher value will give better context but will cost more.