@adminforth/text-complete 1.0.21

package/index.ts

@@ -0,0 +1,174 @@
+
+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;
+
+  constructor(options: PluginOptions) {
+    super(options, import.meta.url);
+    this.options = options;
+  }
+
+  instanceUniqueRepresentation(pluginOptions: any) : string {
+    return `${pluginOptions.fieldName}`;
+  }
+
+ 
+  validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+    this.adminforth = adminforth;
+    const column = this.resourceConfig.columns.find(f => f.name === this.options.fieldName);
+    if (![AdminForthDataTypes.STRING, AdminForthDataTypes.TEXT].includes(column!.type!)) {
+      throw new Error(`Field ${this.options.fieldName} should be string or text type, but it is ${column!.type}`);
+    }
+    if (!this.options.adapter) {
+      throw new Error('adapter is required');
+    }
+  }
+
+  generateRecordContext(record: any, maxFields: number, inputFieldLimit: number, partsCount: number): string {
+    // stringify each field
+    let fields: [string, string][] = Object.entries(record).map(([key, value]) => {
+      return [key, JSON.stringify(value)];
+    });
+
+    // sort fields by length, higher first
+    fields = fields.sort((a, b) => b[1].length - a[1].length);
+
+    // select longest maxFields fields
+    fields = fields.slice(0, maxFields);
+
+    const minLimit = '...'.length * partsCount;
+
+    if (inputFieldLimit < minLimit) {
+      throw new Error(`inputFieldLimit should be at least ${minLimit}`);
+    }
+
+    // for each field, if it is longer than inputFieldLimit, truncate it using next way:
+    // split into 5 parts, divide inputFieldLimit by 5, crop each part to this length, join parts using '...'
+    fields = fields.map(([key, value]) => {
+      if (value.length > inputFieldLimit) {
+        const partLength = Math.floor(inputFieldLimit / partsCount) - '...'.length;
+        const parts = [];
+        for (let i = 0; i < partsCount; i++) {
+          parts.push(value.slice(i * partLength, (i + 1) * partLength));
+        }
+        value = parts.join('...');
+        return [key, value];
+      }
+      return [key, value];
+    });
+
+    return JSON.stringify(Object.fromEntries(fields));
+  }
+
+  setupEndpoints(server: IHttpServer) {
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/doComplete`,
+      handler: async ({ body, headers }) => {
+        if (this.options.rateLimit?.limit) {
+          // rate limit
+          const { error } = RateLimiter.checkRateLimit(
+            this.pluginInstanceId, 
+            this.options.rateLimit?.limit,
+            this.adminforth.auth.getClientIp(headers),
+          );
+          if (error) {
+            return {
+              completion: [],
+            }
+          }
+        }
+
+        const { record } = body;
+        const recordNoField = {...record};
+        delete recordNoField[this.options.fieldName];
+        let currentVal = record[this.options.fieldName];
+        const promptLimit = this.options.expert?.promptInputLimit || 500;
+        const inputContext = this.generateRecordContext(
+          recordNoField,
+          this.options.expert?.recordContext?.maxFields || 5, 
+          this.options.expert?.recordContext?.maxFieldLength || 300,
+          this.options.expert?.recordContext?.splitParts || 5,
+        );
+
+        if (currentVal && currentVal.length > promptLimit) {
+          currentVal = currentVal.slice(-promptLimit);
+        }
+
+        const resLabel = this.resourceConfig.label;
+       
+        let content;
+        
+        if (currentVal) {
+          content = `Continue writing for text/string field "${this.options.fieldName}" in the table "${resLabel}"\n` +
+              (Object.keys(recordNoField).length > 0 ? `Record has values for the context: ${inputContext}\n` : '') +
+              `Current field value: ${currentVal}\n` +
+              "Don't talk to me. Just write text. No quotes. Don't repeat current field value, just write completion\n";
+
+        } else {
+          content = `Fill text/string field "${this.options.fieldName}" in the table "${resLabel}"\n` +
+              (Object.keys(recordNoField).length > 0 ? `Record has values for the context: ${inputContext}\n` : '') +
+              "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 { content: respContent, finishReason } = await this.options.adapter.complete(content, this.options.expert?.stop, this.options.expert?.maxTokens);
+        const stop = this.options.expert?.stop || ['.'];
+        let suggestion = respContent + (
+          finishReason === 'stop' ? (
+            stop[0] === '.' && stop.length === 1 && this.columnType === AdminForthDataTypes.TEXT ? '. ' : ''
+          ) : ''
+        );
+
+        if (suggestion.startsWith(currentVal)) {
+          suggestion = suggestion.slice(currentVal.length);
+        }
+        const wordsList = suggestion.split(' ').map((w, i) => {
+          return (i === suggestion.split(' ').length - 1) ? w : w + ' ';
+        });
+
+        // remove quotes from start and end
+        return {
+          completion: wordsList
+        };
+      }
+    });
+  }
+
+  async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+    super.modifyResourceConfig(adminforth, resourceConfig);
+    this.resourceConfig = resourceConfig;
+
+    // ensure that column exists
+    const column = this.resourceConfig.columns.find(f => f.name === this.options.fieldName);
+    if (!column) {
+      throw new Error(`Field ${this.options.fieldName} not found in resource ${this.resourceConfig.label}`);
+    }
+
+    if (!column.components) {
+      column.components = {};
+    }
+    const filed = {
+      file: this.componentPath('completionInput.vue'),
+      meta: {
+        pluginInstanceId: this.pluginInstanceId,
+        fieldName: this.options.fieldName,
+        debounceTime: this.options.expert?.debounceTime || 300,
+      }
+    }
+    column.components.create = filed;
+    column.components.edit = filed;
+
+    this.columnType = column.type!;
+  }
+
+}

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@adminforth/text-complete",
+  "version": "1.0.21",
+  "description": "",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "rollout": "tsc && rsync -av --exclude 'node_modules' custom dist/ && npm version patch && npm publish --access public",
+    "prepare": "npm link adminforth"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

package/tsconfig.json

@@ -0,0 +1,112 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    // changed from commmonjs to node16 because The 'import.meta' meta-property is only allowed when the '--module' option is 'es2020', 'es2022', 'esnext', 'system', 'node16', or 'nodenext'.
+    "module": "node16",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "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. */
+    // "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. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": false,   /* TODO */                                   /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+  },
+  "exclude": ["node_modules", "dist", "custom"],           /* Exclude files from compilation. */
+}

package/types.ts

@@ -0,0 +1,82 @@
+import { CompletionAdapter } from "adminforth";
+
+export interface PluginOptions {
+  /**
+   * Field where plugin will auto-complete text. Should be string or text field.
+   */
+  fieldName: 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;
+
+    /**
+     * Stop tokens. Default is ['.']
+     */
+    stop?: string[];
+  };
+
+  /**
+   * 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;
+}