@aigne/core 1.63.0-beta.9 → 1.64.0-beta

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## [1.64.0-beta](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.63.0...core-v1.64.0-beta) (2025-10-21)
+
+
+### Features
+
+* add thinking support to Gemini chat models ([#650](https://github.com/AIGNE-io/aigne-framework/issues/650)) ([09b828b](https://github.com/AIGNE-io/aigne-framework/commit/09b828ba668d90cc6aac68a5e8190adb146b5e45))
+* add user context support to prompt template variables ([#649](https://github.com/AIGNE-io/aigne-framework/issues/649)) ([a02d9b4](https://github.com/AIGNE-io/aigne-framework/commit/a02d9b412878050b8c1e32127b505c0346f19bba))
+* **cli:** add metadata traces including CLI version, app name, and version ([#646](https://github.com/AIGNE-io/aigne-framework/issues/646)) ([c64bd76](https://github.com/AIGNE-io/aigne-framework/commit/c64bd761ba4c9f3854be5feee208c711bff7a170))
+
+
+### Bug Fixes
+
+* **gemini:** handle empty responses when files are present ([#648](https://github.com/AIGNE-io/aigne-framework/issues/648)) ([f4e259c](https://github.com/AIGNE-io/aigne-framework/commit/f4e259c5e5c687c347bb5cf29cbb0b5bf4d0d4a1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/observability-api bumped to 0.11.3-beta
+
+## [1.63.0](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.63.0-beta.12...core-v1.63.0) (2025-10-19)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/afs bumped to 1.1.0
+    * @aigne/observability-api bumped to 0.11.2
+
+## [1.63.0-beta.12](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.63.0-beta.11...core-v1.63.0-beta.12) (2025-10-17)
+
+
+### Bug Fixes
+
+* custom queue instead of fastq to compatible with browser ([#640](https://github.com/AIGNE-io/aigne-framework/issues/640)) ([51e0f8f](https://github.com/AIGNE-io/aigne-framework/commit/51e0f8fdeaf26f2765f392218f04a2af4c0d2e1a))
+
+## [1.63.0-beta.11](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.63.0-beta.10...core-v1.63.0-beta.11) (2025-10-17)
+
+
+### Bug Fixes
+
+* **gemini:** implement retry mechanism for empty responses with structured output fallback ([#638](https://github.com/AIGNE-io/aigne-framework/issues/638)) ([d33c8bb](https://github.com/AIGNE-io/aigne-framework/commit/d33c8bb9711aadddef9687d6cf472a179cd8ed9c))
+
+## [1.63.0-beta.10](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.63.0-beta.9...core-v1.63.0-beta.10) (2025-10-16)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/observability-api bumped to 0.11.2-beta.5
+
 ## [1.63.0-beta.9](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.63.0-beta.8...core-v1.63.0-beta.9) (2025-10-16)
 
 

package/lib/cjs/agents/agent.js

@@ -476,7 +476,7 @@ class Agent {
                 if (!res.retry) {
                     const e = res.error ?? error;
                     if (attempt > 0)
-                        e.message += ` (after ${attempt} retries)`;
+                        e.message += ` (after ${attempt + 1} retries)`;
                     throw e;
                 }
             }

package/lib/cjs/agents/ai-agent.js

@@ -1,14 +1,44 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AIAgent = exports.aiAgentOptionsSchema = exports.aiAgentToolChoiceSchema = exports.AIAgentToolChoice = exports.DEFAULT_OUTPUT_FILE_KEY = exports.DEFAULT_OUTPUT_KEY = void 0;
-const fastq_1 = __importDefault(require("fastq"));
 const zod_1 = require("zod");
 const prompt_builder_js_1 = require("../prompt/prompt-builder.js");
 const structured_stream_instructions_js_1 = require("../prompt/prompts/structured-stream-instructions.js");
 const template_js_1 = require("../prompt/template.js");
+const fastq = __importStar(require("../utils/queue.js"));
 const structured_stream_extractor_js_1 = require("../utils/structured-stream-extractor.js");
 const type_utils_js_1 = require("../utils/type-utils.js");
 const agent_js_1 = require("./agent.js");
@@ -319,7 +349,7 @@ class AIAgent extends agent_js_1.Agent {
                 }
                 const executedToolCalls = [];
                 let error;
-                const queue = fastq_1.default.promise(async ({ tool, call }) => {
+                const queue = fastq.promise(async ({ tool, call }) => {
                     try {
                         // NOTE: should pass both arguments (model generated) and input (user provided) to the tool
                         const output = await this.invokeSkill(tool, { ...input, ...call.function.arguments }, options).catch((error) => {

package/lib/cjs/agents/chat-model.d.ts

@@ -407,6 +407,10 @@ export interface ChatModelOutput extends Message {
      * Text format response content
      */
     text?: string;
+    /**
+     * Model's internal thoughts (if supported)
+     */
+    thoughts?: string;
     /**
      * JSON format response content
      */

package/lib/cjs/agents/chat-model.js

@@ -38,11 +38,12 @@ const index_js_1 = require("@aigne/platform-helpers/nodejs/index.js");
 const zod_1 = require("zod");
 const zod_from_json_schema_1 = require("zod-from-json-schema");
 const json_schema_js_1 = require("../utils/json-schema.js");
+const logger_js_1 = require("../utils/logger.js");
 const type_utils_js_1 = require("../utils/type-utils.js");
 const agent_js_1 = require("./agent.js");
 const model_js_1 = require("./model.js");
 const CHAT_MODEL_DEFAULT_RETRY_OPTIONS = {
-    retries: 10,
+    retries: 3,
     shouldRetry: async (error) => error instanceof StructuredOutputError || (await Promise.resolve().then(() => __importStar(require("is-network-error")))).default(error),
 };
 class StructuredOutputError extends Error {
@@ -215,7 +216,10 @@ class ChatModel extends model_js_1.Model {
      */
     async postprocess(input, output, options) {
         super.postprocess(input, output, options);
-        const { usage } = output;
+        const { usage, thoughts, model } = output;
+        if (thoughts) {
+            logger_js_1.logger.info(`Model Thoughts (${model}): ${thoughts}`);
+        }
         if (usage) {
             options.context.usage.outputTokens += usage.outputTokens;
             options.context.usage.inputTokens += usage.inputTokens;
@@ -360,6 +364,7 @@ exports.chatModelOutputUsageSchema = zod_1.z.object({
 });
 const chatModelOutputSchema = zod_1.z.object({
     text: zod_1.z.string().optional(),
+    thoughts: zod_1.z.string().optional(),
     json: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
     toolCalls: zod_1.z.array(chatModelOutputToolCallSchema).optional(),
     usage: exports.chatModelOutputUsageSchema.optional(),

package/lib/cjs/agents/image-agent.d.ts

@@ -5,6 +5,7 @@ import { type ImageModelOutput } from "./image-model.js";
 import { type FileType } from "./model.js";
 export interface ImageAgentOptions<I extends Message = any, O extends ImageModelOutput = any> extends Omit<AgentOptions<I, O>, "outputSchema"> {
     instructions: string | PromptBuilder;
+    inputFileKey?: string;
     modelOptions?: Record<string, any>;
     outputFileType?: FileType;
 }
@@ -16,6 +17,7 @@ export declare class ImageAgent<I extends Message = any, O extends ImageModelOut
     static from<I extends Message = any, O extends ImageModelOutput = any>(options: ImageAgentOptions<I, O>): ImageAgent<I, O>;
     constructor(options: ImageAgentOptions<I, O>);
     instructions: PromptBuilder;
+    inputFileKey?: string;
     modelOptions?: Record<string, any>;
     outputFileType?: FileType;
     process(input: I, options: AgentInvokeOptions): Promise<O>;

package/lib/cjs/agents/image-agent.js

@@ -27,18 +27,30 @@ class ImageAgent extends agent_js_1.Agent {
             typeof options.instructions === "string"
                 ? prompt_builder_js_1.PromptBuilder.from(options.instructions)
                 : options.instructions;
+        this.inputFileKey = options.inputFileKey;
         this.modelOptions = options.modelOptions;
         this.outputFileType = options.outputFileType;
     }
     instructions;
+    inputFileKey;
     modelOptions;
     outputFileType;
     async process(input, options) {
         const imageModel = this.imageModel || options.imageModel || options.context.imageModel;
         if (!imageModel)
             throw new Error("image model is required to run ImageAgent");
-        const { prompt } = await this.instructions.buildImagePrompt({ input });
-        return (await this.invokeChildAgent(imageModel, { ...input, modelOptions: this.modelOptions, prompt, outputFileType: this.outputFileType }, { ...options, streaming: false }));
+        const { prompt, image } = await this.instructions.buildImagePrompt({
+            ...options,
+            input,
+            agent: this,
+        });
+        return (await this.invokeChildAgent(imageModel, {
+            ...input,
+            modelOptions: this.modelOptions,
+            prompt,
+            image,
+            outputFileType: this.outputFileType,
+        }, { ...options, streaming: false }));
     }
 }
 exports.ImageAgent = ImageAgent;

package/lib/cjs/agents/team-agent.js

@@ -1,12 +1,45 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TeamAgent = exports.DEFAULT_REFLECTION_MAX_ITERATIONS = exports.ProcessMode = void 0;
 const node_assert_1 = __importDefault(require("node:assert"));
-const fastq_1 = __importDefault(require("fastq"));
 const immer_1 = require("immer");
+const fastq = __importStar(require("../utils/queue.js"));
 const stream_utils_js_1 = require("../utils/stream-utils.js");
 const type_utils_js_1 = require("../utils/type-utils.js");
 const agent_js_1 = require("./agent.js");
@@ -201,7 +234,7 @@ class TeamAgent extends agent_js_1.Agent {
         arr = Array.isArray(arr) ? [...arr] : (0, type_utils_js_1.isNil)(arr) ? [arr] : [];
         const results = new Array(arr.length);
         let error;
-        const queue = fastq_1.default.promise(async ({ item, index }) => {
+        const queue = fastq.promise(async ({ item, index }) => {
             try {
                 if (!(0, type_utils_js_1.isRecord)(item))
                     throw new TypeError(`Expected ${String(key)} to be an object, got ${typeof item}`);

package/lib/cjs/aigne/aigne.d.ts

@@ -6,7 +6,7 @@ import type { UserAgent } from "../agents/user-agent.js";
 import { type LoadOptions } from "../loader/index.js";
 import { AIGNEContext, type Context, type InvokeOptions, type UserContext } from "./context.js";
 import { type MessagePayload, MessageQueue, type MessageQueueListener, type Unsubscribe } from "./message-queue.js";
-import type { AIGNECLIAgents } from "./type.js";
+import type { AIGNECLIAgents, AIGNEMetadata } from "./type.js";
 import type { ContextLimits } from "./usage.js";
 /**
  * Options for the AIGNE class.
@@ -53,6 +53,7 @@ export interface AIGNEOptions {
      * Observer for the AIGNE instance.
      */
     observer?: AIGNEObserver;
+    metadata?: AIGNEMetadata;
 }
 /**
  * AIGNE is a class that orchestrates multiple agents to build complex AI applications.
@@ -136,6 +137,10 @@ export declare class AIGNE<U extends UserContext = UserContext> {
      * Observer for the AIGNE instance.
      */
     readonly observer?: AIGNEObserver;
+    /**
+     * Metadata for the AIGNE instance.
+     */
+    readonly metadata: AIGNEMetadata;
     /**
      * Adds one or more agents to this AIGNE instance.
      * Each agent is attached to this AIGNE instance, allowing it to access the AIGNE's resources.

package/lib/cjs/aigne/aigne.js

@@ -37,6 +37,7 @@ class AIGNE {
             imageModel,
             agents: agents.concat(options?.agents ?? []),
             skills: skills.concat(options?.skills ?? []),
+            metadata: options?.metadata,
         });
     }
     /**
@@ -66,6 +67,7 @@ class AIGNE {
         this.cli = options?.cli ?? {};
         this.observer?.serve();
         this.initProcessExitHandler();
+        this.metadata = options?.metadata ?? {};
     }
     /**
      * Optional root directory for this AIGNE instance.
@@ -115,6 +117,10 @@ class AIGNE {
      * Observer for the AIGNE instance.
      */
     observer;
+    /**
+     * Metadata for the AIGNE instance.
+     */
+    metadata = {};
     /**
      * Adds one or more agents to this AIGNE instance.
      * Each agent is attached to this AIGNE instance, allowing it to access the AIGNE's resources.

package/lib/cjs/aigne/context.d.ts

@@ -9,6 +9,7 @@ import type { Memory } from "../memory/memory.js";
 import { type OmitPropertiesFromArrayFirstElement } from "../utils/type-utils.js";
 import type { Args, Listener, TypedEventEmitter } from "../utils/typed-event-emitter.js";
 import { type MessagePayload, MessageQueue, type MessageQueueListener, type Unsubscribe } from "./message-queue.js";
+import type { AIGNEMetadata } from "./type.js";
 import { type ContextLimits, type ContextUsage } from "./usage.js";
 /**
  * @hidden
@@ -78,6 +79,7 @@ export interface Context<U extends UserContext = UserContext> extends TypedEvent
     skills?: Agent[];
     agents: Agent[];
     observer?: AIGNEObserver;
+    metadata?: AIGNEMetadata;
     span?: Span;
     usage: ContextUsage;
     limits?: ContextLimits;
@@ -187,7 +189,7 @@ export declare class AIGNEContext implements Context {
 }
 declare class AIGNEContextShared {
     private readonly parent?;
-    constructor(parent?: (Pick<Context, "model" | "imageModel" | "agents" | "skills" | "limits" | "observer"> & {
+    constructor(parent?: (Pick<Context, "model" | "imageModel" | "agents" | "skills" | "limits" | "observer" | "metadata"> & {
         messageQueue?: MessageQueue;
         events?: Emitter<any>;
     }) | undefined);
@@ -198,6 +200,7 @@ declare class AIGNEContextShared {
     get skills(): Agent<any, any>[] | undefined;
     get agents(): Agent<any, any>[];
     get observer(): AIGNEObserver | undefined;
+    get metadata(): AIGNEMetadata | undefined;
     get limits(): ContextLimits | undefined;
     usage: ContextUsage;
     userContext: Context["userContext"];

package/lib/cjs/aigne/context.js

@@ -217,6 +217,7 @@ class AIGNEContext {
                     if (this.parentId) {
                         span.setAttribute("custom.parent_id", this.parentId);
                     }
+                    span.setAttribute("metadata", JSON.stringify(this.internal.metadata ?? {}));
                     span.setAttribute("custom.started_at", b.timestamp);
                     span.setAttribute("input", JSON.stringify(input));
                     span.setAttribute("agentTag", agent.tag ?? "UnknownAgent");
@@ -300,6 +301,9 @@ class AIGNEContextShared {
     get observer() {
         return this.parent?.observer;
     }
+    get metadata() {
+        return this.parent?.metadata;
+    }
     get limits() {
         return this.parent?.limits;
     }

package/lib/cjs/aigne/type.d.ts

@@ -10,3 +10,17 @@ export interface AIGNECLIAgent {
     description?: string;
     agents?: AIGNECLIAgent[];
 }
+export interface AIGNEMetadata {
+    /**
+     * CLI version (e.g., "1.51.0")
+     */
+    cliVersion?: string;
+    /**
+     * Application name (e.g., "docsmith", "websmith")
+     */
+    appName?: string;
+    /**
+     * Application version (e.g., "2.3.4")
+     */
+    appVersion?: string;
+}

package/lib/cjs/loader/agent-yaml.d.ts

@@ -59,6 +59,7 @@ export interface AIAgentSchema extends BaseAgentSchema {
     inputKey?: string;
     inputFileKey?: string;
     outputKey?: string;
+    outputFileKey?: string;
     toolChoice?: AIAgentToolChoice;
     toolCallsConcurrency?: number;
     keepTextInToolUses?: boolean;
@@ -66,6 +67,7 @@ export interface AIAgentSchema extends BaseAgentSchema {
 export interface ImageAgentSchema extends BaseAgentSchema {
     type: "image";
     instructions: Instructions;
+    inputFileKey?: string;
     modelOptions?: Record<string, any>;
 }
 export interface MCPAgentSchema extends BaseAgentSchema {

package/lib/cjs/loader/agent-yaml.js

@@ -128,6 +128,7 @@ async function parseAgentFile(path, data) {
                 .object({
                 type: zod_1.z.literal("image"),
                 instructions: instructionsSchema,
+                inputFileKey: (0, schema_js_1.optionalize)(zod_1.z.string()),
                 modelOptions: (0, schema_js_1.optionalize)((0, schema_js_1.camelizeSchema)(zod_1.z.record(zod_1.z.any()))),
             })
                 .extend(baseAgentSchema.shape),

package/lib/cjs/prompt/prompt-builder.d.ts

@@ -2,6 +2,8 @@ import type { GetPromptResult } from "@modelcontextprotocol/sdk/types.js";
 import { Agent, type AgentInvokeOptions, type Message } from "../agents/agent.js";
 import { type AIAgent } from "../agents/ai-agent.js";
 import type { ChatModel, ChatModelInput } from "../agents/chat-model.js";
+import type { ImageAgent } from "../agents/image-agent.js";
+import { type FileUnionContent } from "../agents/model.js";
 import { ChatMessagesTemplate } from "./template.js";
 export interface PromptBuilderOptions {
     instructions?: string | ChatMessagesTemplate;
@@ -27,9 +29,13 @@ export declare class PromptBuilder {
     build(options: PromptBuildOptions): Promise<ChatModelInput & {
         toolAgents?: Agent[];
     }>;
-    buildImagePrompt(options: Pick<PromptBuildOptions, "input">): Promise<{
+    buildImagePrompt(options: Pick<PromptBuildOptions, "input" | "context"> & {
+        agent: ImageAgent;
+    }): Promise<{
         prompt: string;
+        image?: FileUnionContent[];
     }>;
+    private getTemplateVariables;
     private buildMessages;
     private refineMessages;
     private convertMemoriesToMessages;

package/lib/cjs/prompt/prompt-builder.js

@@ -78,9 +78,21 @@ class PromptBuilder {
     async buildImagePrompt(options) {
         const messages = (await (typeof this.instructions === "string"
             ? template_js_1.ChatMessagesTemplate.from([template_js_1.SystemMessageTemplate.from(this.instructions)])
-            : this.instructions)?.format(options.input, { workingDir: this.workingDir })) ?? [];
+            : this.instructions)?.format(this.getTemplateVariables(options), { workingDir: this.workingDir })) ?? [];
+        const inputFileKey = options.agent?.inputFileKey;
+        const files = (0, type_utils_js_1.flat)(inputFileKey
+            ? (0, type_utils_js_1.checkArguments)("Check input files", (0, schema_js_1.optionalize)(model_js_1.fileUnionContentsSchema), options.input?.[inputFileKey])
+            : null);
         return {
             prompt: messages.map((i) => i.content).join("\n"),
+            image: files.length ? files : undefined,
+        };
+    }
+    getTemplateVariables(options) {
+        return {
+            userContext: options.context?.userContext,
+            ...options.context?.userContext,
+            ...options.input,
         };
     }
     async buildMessages(options) {
@@ -89,7 +101,7 @@ class PromptBuilder {
         const message = inputKey && typeof input?.[inputKey] === "string" ? input[inputKey] : undefined;
         const [messages, otherCustomMessages] = (0, type_utils_js_1.partition)((await (typeof this.instructions === "string"
             ? template_js_1.ChatMessagesTemplate.from([template_js_1.SystemMessageTemplate.from(this.instructions)])
-            : this.instructions)?.format(options.input, { workingDir: this.workingDir })) ?? [], (i) => i.role === "system");
+            : this.instructions)?.format(this.getTemplateVariables(options), { workingDir: this.workingDir })) ?? [], (i) => i.role === "system");
         const inputFileKey = options.agent?.inputFileKey;
         const files = (0, type_utils_js_1.flat)(inputFileKey
             ? (0, type_utils_js_1.checkArguments)("Check input files", (0, schema_js_1.optionalize)(model_js_1.fileUnionContentsSchema), input?.[inputFileKey])

package/lib/cjs/utils/model-utils.js

@@ -5,5 +5,6 @@ function mergeUsage(...usages) {
     return {
         inputTokens: usages.reduce((acc, usage) => (usage ? acc + usage.inputTokens : acc), 0),
         outputTokens: usages.reduce((acc, usage) => (usage ? acc + usage.outputTokens : acc), 0),
+        aigneHubCredits: usages.reduce((acc, usage) => (usage?.aigneHubCredits ? acc + usage.aigneHubCredits : acc), 0),
     };
 }

package/lib/cjs/utils/queue.d.ts

@@ -0,0 +1,57 @@
+/** biome-ignore-all lint/style/noNonNullAssertion lint/complexity/useOptionalChain: <!> */
+declare namespace fastq {
+    type worker<C, T = any, R = any> = (this: C, task: T, cb: fastq.done<R>) => void;
+    type asyncWorker<C, T = any, R = any> = (this: C, task: T) => Promise<R>;
+    type done<R = any> = (err: Error | null, result?: R) => void;
+    type errorHandler<T = any> = (err: Error, task: T) => void;
+    interface queue<T = any, R = any> {
+        /** Add a task at the end of the queue. `done(err, result)` will be called when the task was processed. */
+        push(task: T, done?: done<R>): void;
+        /** Add a task at the beginning of the queue. `done(err, result)` will be called when the task was processed. */
+        unshift(task: T, done?: done<R>): void;
+        /** Pause the processing of tasks. Currently worked tasks are not stopped. */
+        pause(): any;
+        /** Resume the processing of tasks. */
+        resume(): any;
+        running(): number;
+        /** Returns `false` if there are tasks being processed or waiting to be processed. `true` otherwise. */
+        idle(): boolean;
+        /** Returns the number of tasks waiting to be processed (in the queue). */
+        length(): number;
+        /** Returns all the tasks be processed (in the queue). Returns empty array when there are no tasks */
+        getQueue(): T[];
+        /** Removes all tasks waiting to be processed, and reset `drain` to an empty function. */
+        kill(): any;
+        /** Same than `kill` but the `drain` function will be called before reset to empty. */
+        killAndDrain(): any;
+        /** Set a global error handler. `handler(err, task)` will be called each time a task is completed, `err` will be not null if the task has thrown an error. */
+        error(handler: errorHandler<T>): void;
+        /** Property that returns the number of concurrent tasks that could be executed in parallel. It can be altered at runtime. */
+        concurrency: number;
+        /** Property that returns `true` when the queue is in a paused state. */
+        paused: boolean;
+        /** Function that will be called when the last item from the queue has been processed by a worker. It can be altered at runtime. */
+        drain(): any;
+        /** Function that will be called when the last item from the queue has been assigned to a worker. It can be altered at runtime. */
+        empty: () => void;
+        /** Function that will be called when the queue hits the concurrency limit. It can be altered at runtime. */
+        saturated: () => void;
+    }
+    interface queueAsPromised<T = any, R = any> extends queue<T, R> {
+        /** Add a task at the end of the queue. The returned `Promise` will be fulfilled (rejected) when the task is completed successfully (unsuccessfully). */
+        push(task: T): Promise<R>;
+        /** Add a task at the beginning of the queue. The returned `Promise` will be fulfilled (rejected) when the task is completed successfully (unsuccessfully). */
+        unshift(task: T): Promise<R>;
+        /** Wait for the queue to be drained. The returned `Promise` will be resolved when all tasks in the queue have been processed by a worker. */
+        drained(): Promise<void>;
+    }
+}
+declare function fastq<C, T = any, R = any>(context: C, worker: fastq.worker<C, T, R>, _concurrency: number): fastq.queue<T, R>;
+declare function fastq<C, T = any, R = any>(worker: fastq.worker<C, T, R>, _concurrency: number): fastq.queue<T, R>;
+declare namespace fastq {
+    var promise: typeof queueAsPromised;
+}
+declare function queueAsPromised<C, T = any, R = any>(context: C, worker: fastq.asyncWorker<C, T, R>, _concurrency: number): fastq.queueAsPromised<T, R>;
+declare function queueAsPromised<C, T = any, R = any>(worker: fastq.asyncWorker<C, T, R>, _concurrency: number): fastq.queueAsPromised<T, R>;
+export default fastq;
+export declare const promise: typeof queueAsPromised;