@adminforth/rich-editor 1.0.15 → 1.0.17

package/ChangeLog.md

@@ -1,5 +1,11 @@
+## [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/dist/index.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { AdminForthPlugin, Filters, getClientIp, RateLimiter } from "adminforth";
+import { AdminForthPlugin, Filters, RateLimiter } from "adminforth";
 import * as cheerio from 'cheerio';
 // options:
 // attachments: {
@@ -31,6 +31,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             _super.modifyResourceConfig.call(this, adminforth, resourceConfig);
+            this.adminforth = adminforth;
             const c = resourceConfig.columns.find(c => c.name === this.options.htmlFieldName);
             if (!c) {
                 throw new Error(`Column ${this.options.htmlFieldName} not found in resource ${resourceConfig.label}`);
@@ -160,9 +161,10 @@ export default class RichEditorPlugin extends AdminForthPlugin {
         });
     }
     validateConfigAfterDiscover(adminforth, resourceConfig) {
+        this.adminforth = adminforth;
         // 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) {
@@ -204,11 +206,11 @@ 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
-                    const { error } = RateLimiter.checkRateLimit(this.pluginInstanceId, (_c = this.options.completion.rateLimit) === null || _c === void 0 ? void 0 : _c.limit, getClientIp(headers));
+                    const { error } = RateLimiter.checkRateLimit(this.pluginInstanceId, (_c = this.options.completion.rateLimit) === null || _c === void 0 ? void 0 : _c.limit, this.adminforth.auth.getClientIp(headers));
                     if (error) {
                         return {
                             completion: [],
@@ -237,28 +239,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,7 +1,7 @@
 
 import type { IAdminForth, IHttpServer, AdminForthResource, AdminUser, AfterSaveFunction } from "adminforth";
 import type { PluginOptions } from './types.js';
-import { AdminForthPlugin, Filters, getClientIp, RateLimiter } from "adminforth";
+import { AdminForthPlugin, Filters, RateLimiter } from "adminforth";
 import * as cheerio from 'cheerio';
 
 
@@ -22,6 +22,8 @@ export default class RichEditorPlugin extends AdminForthPlugin {
   activationOrder: number = 100000;
 
   attachmentResource: AdminForthResource = undefined;
+
+  adminforth: IAdminForth;
   
   constructor(options: PluginOptions) {
     super(options, import.meta.url);
@@ -30,6 +32,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
 
   async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
     super.modifyResourceConfig(adminforth, resourceConfig);
+    this.adminforth = adminforth;
 
     const c = resourceConfig.columns.find(c => c.name === this.options.htmlFieldName);
     if (!c) {
@@ -204,9 +207,10 @@ export default class RichEditorPlugin extends AdminForthPlugin {
   }
   
   validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+    this.adminforth = adminforth;
     // 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`);
     }
 
   }
@@ -265,7 +269,7 @@ export default class RichEditorPlugin extends AdminForthPlugin {
           const { error } = RateLimiter.checkRateLimit(
             this.pluginInstanceId, 
             this.options.completion.rateLimit?.limit,
-            getClientIp(headers),
+            this.adminforth.auth.getClientIp(headers),
           );
           if (error) {
             return {
@@ -306,29 +310,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.15",
+  "version": "1.0.17",
   "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. 

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

@@ -1,66 +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==",
-      "license": "BSD-3-Clause",
-      "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/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/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)