@adminforth/text-complete 2.0.14 → 2.0.16

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { IAdminForth, IHttpServer, AdminForthPlugin, AdminForthResource, AdminForthDataTypes, RateLimiter } from "adminforth";
+import { PluginOptions } from './types.js';
+export default class TextCompletePlugin extends AdminForthPlugin {
+    options: PluginOptions;
+    resourceConfig: AdminForthResource;
+    columnType: AdminForthDataTypes;
+    adminforth: IAdminForth;
+    rateLimiter?: RateLimiter;
+    constructor(options: PluginOptions);
+    instanceUniqueRepresentation(pluginOptions: any): string;
+    validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    generateRecordContext(record: any, maxFields: number, inputFieldLimit: number, partsCount: number): string;
+    setupEndpoints(server: IHttpServer): void;
+    modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): Promise<void>;
+}

package/dist/types.d.ts

@@ -0,0 +1,76 @@
+import { CompletionAdapter } from "adminforth";
+import { type PluginsCommonOptions } from "adminforth";
+export interface PluginOptions extends PluginsCommonOptions {
+    /**
+     * Field where plugin will auto-complete text. Should be string or text field.
+     */
+    fieldName: string;
+    /**
+     * Initial prompt request when field is empty. Mustache syntax for record context fields is supported.
+     * E.g.
+     * 'I need to introduce "{{ name }}" technology to my software development company website, I need short but very attractive description if it.'
+     *
+     * Where `name` is a field name which contains technology name e.g. Vue.js
+     */
+    initialPrompt?: string;
+    /**
+     * Expert settings
+     */
+    expert?: {
+        /**
+         * 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.
+         */
+        promptInputLimit?: number;
+        /**
+         * Debounce time in ms. Default is 300. Time after user stopped typing before request will be sent.
+         */
+        debounceTime?: number;
+        /**
+         * When completion is made, this plugin passes non-empty fields of the record to the LLM model for record context understanding.
+         */
+        recordContext?: {
+            /**
+             * Using this field you can limit number of fields passed to the model.
+             * Default is 5.
+             * Completion field is not included in this limit.
+             * Set to 0 to disable context passing at all.
+             * If count of fields exceeds this number, longest fields will be selected.
+             * If some of values will exceed maxFieldLength, it will be smartly truncated by splitting ito splitParts, taking their
+             * starting substring and joining back with '...'.
+             */
+            maxFields?: number;
+            /**
+             * Limit of input field value. Default is 300. If field is longer, it will be truncated.
+             */
+            maxFieldLength?: number;
+            /**
+             * How many parts to split field value if it exceeds maxFieldLength. Default is 5.
+             */
+            splitParts?: number;
+        };
+        /**
+         * Number of tokens to generate. Default is 50. 1 token ~= ¾ words
+         */
+        maxTokens?: 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;
+    };
+    /**
+     * Adapter for completion
+     */
+    adapter: CompletionAdapter;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/text-complete",
-  "version": "2.0.14",
+  "version": "2.0.16",
   "description": "Text completion plugin for adminforth",
   "type": "module",
   "main": "dist/index.js",
@@ -24,7 +24,7 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.10.7",
-    "adminforth": "2.70.0",
+    "adminforth": "2.71.1",
     "semantic-release": "^24.2.1",
     "semantic-release-slack-bot": "^4.0.2",
     "typescript": "^5.7.3"
@@ -55,6 +55,6 @@
     ]
   },
   "peerDependencies": {
-    "adminforth": "^2.70.0"
+    "adminforth": "2.71.1"
   }
 }

package/tsconfig.json

@@ -51,7 +51,7 @@
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 
     /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */