@adminforth/bulk-ai-flow 1.26.1 → 1.26.2

package/build.log

@@ -14,5 +14,5 @@ custom/package.json
 custom/pnpm-lock.yaml
 custom/tsconfig.json
 
-sent 129,923 bytes  received 191 bytes  260,228.00 bytes/sec
+sent 129,913 bytes  received 191 bytes  260,208.00 bytes/sec
 total size is 129,205  speedup is 0.99

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import { AdminForthPlugin } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResource } from "adminforth";
+import type { PluginOptions } from './types.js';
+import { RateLimiter } from "adminforth";
+export default class BulkAiFlowPlugin extends AdminForthPlugin {
+    options: PluginOptions;
+    uploadPlugin: AdminForthPlugin;
+    totalCalls: number;
+    totalDuration: number;
+    rateLimiters: Record<string, RateLimiter>;
+    constructor(options: PluginOptions);
+    private compileTemplates;
+    private compileOutputFieldsTemplates;
+    private compileOutputFieldsTemplatesNoImage;
+    private compileGenerationFieldTemplates;
+    private removeFromPromptFilledFields;
+    private checkRateLimit;
+    private getPromptForImageAnalysis;
+    private getPromptForPlainFields;
+    private analyze_image;
+    private analyzeNoImages;
+    private initialImageGenerate;
+    private regenerateImage;
+    private regenerateCell;
+    modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): Promise<void>;
+    validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    instanceUniqueRepresentation(pluginOptions: any): string;
+    setupEndpoints(server: IHttpServer): void;
+}

package/dist/types.d.ts

@@ -0,0 +1,138 @@
+import { ImageVisionAdapter, ImageGenerationAdapter, CompletionAdapter } from "adminforth";
+import { type PluginsCommonOptions } from "adminforth";
+export interface PluginOptions extends PluginsCommonOptions {
+    /**
+     * Name of the action in three dots menu.
+     */
+    actionName: string;
+    /**
+    * The adapter to use for scaning images and filling fields basing on the image content.
+    */
+    visionAdapter?: ImageVisionAdapter;
+    /**
+     * The adapter to use for text->text generation.
+     */
+    textCompleteAdapter?: CompletionAdapter;
+    /**
+     * The adapter to use for image generation.
+     */
+    imageGenerationAdapter?: ImageGenerationAdapter;
+    /**
+     * List of fields that should be filled based on the image content analysis.
+     */
+    fillFieldsFromImages?: Record<string, string>;
+    /**
+     * List of fields that should be filled based on the text.
+     */
+    fillPlainFields?: Record<string, string>;
+    /**
+     * Number of tokens to generate (Only for text completion adapter). Default is 1000. 1 token ~= ¾ words
+     */
+    fillPlainFieldsMaxTokens?: number;
+    /**
+     * If you want to generate fields or images based on the image content attached images
+     */
+    attachFiles?: ({ record }: {
+        record: any;
+    }) => string[] | Promise<string[]>;
+    /**
+     * List of image fields, that should be filled.
+     */
+    generateImages?: Record<string, {
+        prompt: string;
+        adapter?: ImageGenerationAdapter;
+        /**
+         * The size of the generated image.
+         */
+        outputSize?: string;
+        /**
+         * Since AI generation can be expensive, we can limit the number of requests per IP.
+         * E.g. 5/1d - 5 requests per day
+         * 3/1h - 3 requests per hour
+         */
+        rateLimit?: string;
+        /**
+         * The number of images to regenerate
+         * in one request
+         */
+        countToGenerate: number;
+    }>;
+    /**
+     * Rate limits for each action.
+     */
+    rateLimits?: {
+        fillFieldsFromImages?: string;
+        fillPlainFields?: string;
+        generateImages?: string;
+    };
+    /**
+     * Job refresh rate for each ai flow job in milliseconds
+     */
+    refreshRates?: {
+        fillFieldsFromImages?: number;
+        fillPlainFields?: number;
+        generateImages?: number;
+        regenerateImages?: number;
+    };
+    /**
+     * Whether the user is allowed to save the generated images
+     */
+    isAllowedToSave?: ({ record, adminUser, resource }: {
+        record: any;
+        adminUser: any;
+        resource: any;
+    }) => Promise<{
+        ok: boolean;
+        error: string;
+    } | {
+        ok: boolean;
+        error?: undefined;
+    }>;
+    /**
+     * Custom message for the context shown to the user when performing the action
+     */
+    provideAdditionalContextForRecord?: ({ record, adminUser, resource }: {
+        record: any;
+        adminUser: any;
+        resource: any;
+    }) => Record<string, any> | Promise<Record<string, any>>;
+    askConfirmationBeforeGenerating?: boolean;
+    /**
+     * Maximum number of records processed concurrently on the frontend.
+     */
+    concurrencyLimit?: number;
+    /**
+     * Defines the way how records are selected for the action.
+     *
+     * 'checkbox' means that user will select records manually by checkboxes,
+     *
+     * 'filtered' means that action will be applied to all records matching current
+     *  filters without showing any checkboxes (use with caution).
+     *
+     * Default is 'checkbox'.
+     */
+    recordSelector?: 'checkbox' | 'filtered';
+    /**
+     * Additional confirmation settings for long-running generations.
+     *
+     * Generating a very large number of records can be expensive. This option
+     * lets you pause the process at specific checkpoints so the user can review
+     * everything generated so far and then choose to Resume or Stop the
+     * generation.
+     *
+     * Each entry in the array defines a confirmation breakpoint:
+     * - `{ afterRecords: N }` – show a confirmation once, after the first N
+     *   records have been processed.
+     * - `{ everyRecords: N }` – show a confirmation after every N records.
+     */
+    askConfirmation?: ({
+        afterRecords: number;
+    } | {
+        everyRecords: number;
+    })[];
+    /**
+     * Number of cards to show per page in the VisionTable component.
+     * If omitted, the component falls back to 6.
+     */
+    pageSize?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/bulk-ai-flow",
-  "version": "1.26.1",
+  "version": "1.26.2",
   "publishConfig": {
     "access": "public"
   },

package/tsconfig.json

@@ -2,6 +2,7 @@
     "compilerOptions": {
       "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
       "module": "node16",                                /* Specify what module code is generated. */
+    "declaration": true,
       "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
       "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules.  */
       "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */