Skip to content

Commit 5280e2f

Browse files
committed
feat: enhance README and update package metadata for Bulk AI Flow Plugin
1 parent 8b19077 commit 5280e2f

4 files changed

Lines changed: 50 additions & 16 deletions

File tree

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
11
# AdminForth Bulk AI Flow Plugin
22

3-
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" /> <img src="https://woodpecker.devforth.io/api/badges/3848/status.svg" alt="Build Status" /> <a href="https://www.npmjs.com/package/@adminforth/bulk-ai-flow"> <img src="https://img.shields.io/npm/dt/@adminforth/bulk-ai-flow" alt="npm downloads" /></a> <a href="https://www.npmjs.com/package/@adminforth/bulk-ai-flow"><img src="https://img.shields.io/npm/v/@adminforth/bulk-ai-flow" alt="npm version" /></a> <a href="https://www.npmjs.com/package/@adminforth/bulk-ai-flow">
3+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" /> <img src="https://woodpecker.devforth.io/api/badges/3848/status.svg" alt="Build Status" /> <a href="https://www.npmjs.com/package/@adminforth/bulk-ai-flow"><img src="https://img.shields.io/npm/dm/@adminforth/bulk-ai-flow" alt="npm downloads" /></a> <a href="https://www.npmjs.com/package/@adminforth/bulk-ai-flow"><img src="https://img.shields.io/npm/v/@adminforth/bulk-ai-flow" alt="npm version" /></a>
44

5-
Allows you to log changes made to table records via adminforth.
5+
[![Ask AI](https://tluma.ai/badge)](https://tluma.ai/ask-ai/devforth/adminforth)
66

7-
## For usage, see [AdminForth Bulk AI Flow Documentation](https://adminforth.dev/docs/tutorial/Plugins/bulk-ai-flow/)
7+
Allows you to generate record data and images in bulk using AI flows in AdminForth.
8+
9+
## Features
10+
11+
- Generate record data in bulk with AI-powered flows.
12+
- Produce content and images for multiple entries faster.
13+
- Reduce repetitive manual work in content operations.
14+
- Plug AI generation into AdminForth resource workflows.
15+
16+
## Documentation
17+
18+
Full setup and configuration guide:
19+
20+
[AdminForth Bulk AI Flow Documentation](https://adminforth.dev/docs/tutorial/Plugins/bulk-ai-flow/)
21+
22+
## About AdminForth
23+
24+
AdminForth is an open-source, agent-first admin framework for building robust admin panels and back-office applications faster.
25+
26+
## Related links
27+
28+
- [AdminForth website](https://adminforth.dev)
29+
- [npm package](https://www.npmjs.com/package/@adminforth/bulk-ai-flow)
30+
- [More AdminForth plugins](https://adminforth.dev/docs/tutorial/ListOfPlugins/)
31+
- [Built by DevForth](https://devforth.io)

index.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,10 @@ export default class BulkAiFlowPlugin extends AdminForthPlugin {
226226
const numberOfTokens = this.options.fillPlainFieldsMaxTokens ? this.options.fillPlainFieldsMaxTokens : 1000;
227227
let resp: any;
228228
try {
229-
const { content: chatResponse, error: topLevelError } = await this.options.textCompleteAdapter.complete(prompt, numberOfTokens);
229+
const { content: chatResponse, error: topLevelError } = await this.options.textCompleteAdapter.complete({
230+
content: prompt,
231+
maxTokens: numberOfTokens,
232+
});
230233
// resp = (chatResponse as any).response;
231234
if (topLevelError || resp?.error) {
232235
isError = true;
@@ -495,7 +498,10 @@ export default class BulkAiFlowPlugin extends AdminForthPlugin {
495498
const numberOfTokens = this.options.fillPlainFieldsMaxTokens ? this.options.fillPlainFieldsMaxTokens : 1000;
496499
let resp;
497500
try {
498-
const { content: chatResponse, error: topLevelError } = await this.options.textCompleteAdapter.complete(finalPrompt, numberOfTokens);
501+
const { content: chatResponse, error: topLevelError } = await this.options.textCompleteAdapter.complete({
502+
content: finalPrompt,
503+
maxTokens: numberOfTokens,
504+
});
499505
if (topLevelError) {
500506
// return { ok: false, error: `ERROR: ${JSON.stringify(topLevelError)}` };
501507
jobs.set(jobId, { status: 'failed', error: `ERROR: ${JSON.stringify(topLevelError)}` });

package.json

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,25 @@
77
"main": "dist/index.js",
88
"types": "dist/index.d.ts",
99
"type": "module",
10+
"homepage": "https://adminforth.dev/docs/tutorial/Plugins/bulk-ai-flow/",
1011
"scripts": {
1112
"build": "tsc && rsync -av --exclude 'node_modules' custom dist/"
1213
},
1314
"keywords": [
1415
"adminforth",
15-
"bulk",
16-
"ai",
17-
"flow"
16+
"ai-workflows",
17+
"batch-generation",
18+
"record-enrichment",
19+
"prompt-templates",
20+
"image-processing",
21+
"field-generation"
1822
],
1923
"author": "",
2024
"license": "MIT",
21-
"description": "",
25+
"description": "Bulk AI workflow plugin for AdminForth for batch field generation and image processing",
2226
"devDependencies": {
2327
"@types/node": "latest",
24-
"adminforth": "^2.35.0",
28+
"adminforth": "^2.42.0",
2529
"semantic-release": "^24.2.1",
2630
"semantic-release-slack-bot": "^4.0.2",
2731
"typescript": "^5.7.3"
@@ -31,7 +35,7 @@
3135
"handlebars": "^4.7.8"
3236
},
3337
"peerDependencies": {
34-
"adminforth": "^2.35.0"
38+
"adminforth": "^2.42.0"
3539
},
3640
"release": {
3741
"plugins": [

pnpm-lock.yaml

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)