@adminforth/rich-editor 1.0.11 → 1.0.12

package/ChangeLog.md

@@ -1,5 +1,5 @@
 
 
-## [1.0.15]
-
--- Add image uploads support
+## [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 } from "adminforth";
+import { AdminForthPlugin, Filters, getClinetIp, RateLimiter } from "adminforth";
 import * as cheerio from 'cheerio';
 // options:
 // attachments: {
@@ -203,14 +203,23 @@ export default class RichEditorPlugin extends AdminForthPlugin {
         server.endpoint({
             method: 'POST',
             path: `/plugin/${this.pluginInstanceId}/doComplete`,
-            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body }) {
-                var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, headers }) {
+                var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
                 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, getClinetIp(headers));
+                    if (error) {
+                        return {
+                            completion: [],
+                        };
+                    }
+                }
                 const recordNoField = Object.assign({}, record);
                 delete recordNoField[this.options.htmlFieldName];
                 let currentVal = record[this.options.htmlFieldName];
-                const promptLimit = ((_b = this.options.completion.expert) === null || _b === void 0 ? void 0 : _b.promptInputLimit) || 500;
-                const inputContext = this.generateRecordContext(recordNoField, ((_d = (_c = this.options.completion.expert) === null || _c === void 0 ? void 0 : _c.recordContext) === null || _d === void 0 ? void 0 : _d.maxFields) || 5, ((_f = (_e = this.options.completion.expert) === null || _e === void 0 ? void 0 : _e.recordContext) === null || _f === void 0 ? void 0 : _f.maxFieldLength) || 300, ((_h = (_g = this.options.completion.expert) === null || _g === void 0 ? void 0 : _g.recordContext) === null || _h === void 0 ? void 0 : _h.splitParts) || 5);
+                const promptLimit = ((_d = this.options.completion.expert) === null || _d === void 0 ? void 0 : _d.promptInputLimit) || 500;
+                const inputContext = this.generateRecordContext(recordNoField, ((_f = (_e = this.options.completion.expert) === null || _e === void 0 ? void 0 : _e.recordContext) === null || _f === void 0 ? void 0 : _f.maxFields) || 5, ((_h = (_g = this.options.completion.expert) === null || _g === void 0 ? void 0 : _g.recordContext) === null || _h === void 0 ? void 0 : _h.maxFieldLength) || 300, ((_k = (_j = this.options.completion.expert) === null || _j === void 0 ? void 0 : _j.recordContext) === null || _k === void 0 ? void 0 : _k.splitParts) || 5);
                 if (currentVal && currentVal.length > promptLimit) {
                     currentVal = currentVal.slice(-promptLimit);
                 }
@@ -228,7 +237,7 @@ 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 = ((_j = this.options.completion.expert) === null || _j === void 0 ? void 0 : _j.stop) || ['.'];
+                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: {
@@ -243,8 +252,8 @@ export default class RichEditorPlugin extends AdminForthPlugin {
                                 content,
                             }
                         ],
-                        temperature: ((_k = this.options.completion.expert) === null || _k === void 0 ? void 0 : _k.temperature) || 0.7,
-                        max_tokens: ((_l = this.options.completion.expert) === null || _l === void 0 ? void 0 : _l.maxTokens) || 50,
+                        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,
                     })
                 });

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 } from "adminforth";
+import { AdminForthPlugin, Filters, getClinetIp, RateLimiter } from "adminforth";
 import * as cheerio from 'cheerio';
 
 
@@ -257,8 +257,23 @@ export default class RichEditorPlugin extends AdminForthPlugin {
     server.endpoint({
       method: 'POST',
       path: `/plugin/${this.pluginInstanceId}/doComplete`,
-      handler: async ({ body }) => {
+      handler: async ({ body, headers }) => {
         const { record } = body;
+
+        if (this.options.completion.rateLimit?.limit) {
+          // rate limit
+          const { error } = RateLimiter.checkRateLimit(
+            this.pluginInstanceId, 
+            this.options.completion.rateLimit?.limit,
+            getClinetIp(headers),
+          );
+          if (error) {
+            return {
+              completion: [],
+            }
+          }
+        }
+
         const recordNoField = {...record};
         delete recordNoField[this.options.htmlFieldName];
         let currentVal = record[this.options.htmlFieldName] as string;

package/package.json

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

package/types.ts

@@ -130,7 +130,25 @@ export interface PluginOptions {
           splitParts?: number;
 
         }
-      }
+    }
+
+    /**
+     * Since AI generation can be expensive, we can limit the number of requests per IP.
+     * Completion will simply stop working when limit is reached so user will not be bothered with error messages.
+     */
+    rateLimit?: {
+
+      /**
+       * E.g. 5/1d - 5 requests per day
+       * 3/1h - 3 requests per hour
+       */ 
+      limit: string,
+
+      /**
+       * Message shown to user when rate limit is reached
+       */
+      errorMessage: string,
+    },
 
   }