@hibanacloud/core 0.3.15

package/dist/src/utils/generateContentResponseUtilities.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { GenerateContentResponse, Part, FunctionCall } from '@google/genai';
+export declare function getResponseTextFromParts(parts: Part[]): string | undefined;
+export declare function getFunctionCalls(response: GenerateContentResponse): FunctionCall[] | undefined;
+export declare function getFunctionCallsFromParts(parts: Part[]): FunctionCall[] | undefined;
+export declare function getFunctionCallsAsJson(response: GenerateContentResponse): string | undefined;
+export declare function getFunctionCallsFromPartsAsJson(parts: Part[]): string | undefined;
+export declare function getStructuredResponse(response: GenerateContentResponse): string | undefined;
+export declare function getStructuredResponseFromParts(parts: Part[]): string | undefined;

package/dist/src/utils/generateContentResponseUtilities.js

@@ -0,0 +1,80 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { getResponseText } from './partUtils.js';
+export function getResponseTextFromParts(parts) {
+    if (!parts) {
+        return undefined;
+    }
+    const textSegments = parts
+        .map((part) => part.text)
+        .filter((text) => typeof text === 'string');
+    if (textSegments.length === 0) {
+        return undefined;
+    }
+    return textSegments.join('');
+}
+export function getFunctionCalls(response) {
+    const parts = response.candidates?.[0]?.content?.parts;
+    if (!parts) {
+        return undefined;
+    }
+    const functionCallParts = parts
+        .filter((part) => !!part.functionCall)
+        .map((part) => part.functionCall);
+    return functionCallParts.length > 0 ? functionCallParts : undefined;
+}
+export function getFunctionCallsFromParts(parts) {
+    if (!parts) {
+        return undefined;
+    }
+    const functionCallParts = parts
+        .filter((part) => !!part.functionCall)
+        .map((part) => part.functionCall);
+    return functionCallParts.length > 0 ? functionCallParts : undefined;
+}
+export function getFunctionCallsAsJson(response) {
+    const functionCalls = getFunctionCalls(response);
+    if (!functionCalls) {
+        return undefined;
+    }
+    return JSON.stringify(functionCalls, null, 2);
+}
+export function getFunctionCallsFromPartsAsJson(parts) {
+    const functionCalls = getFunctionCallsFromParts(parts);
+    if (!functionCalls) {
+        return undefined;
+    }
+    return JSON.stringify(functionCalls, null, 2);
+}
+export function getStructuredResponse(response) {
+    const textContent = getResponseText(response);
+    const functionCallsJson = getFunctionCallsAsJson(response);
+    if (textContent && functionCallsJson) {
+        return `${textContent}\n${functionCallsJson}`;
+    }
+    if (textContent) {
+        return textContent;
+    }
+    if (functionCallsJson) {
+        return functionCallsJson;
+    }
+    return undefined;
+}
+export function getStructuredResponseFromParts(parts) {
+    const textContent = getResponseTextFromParts(parts);
+    const functionCallsJson = getFunctionCallsFromPartsAsJson(parts);
+    if (textContent && functionCallsJson) {
+        return `${textContent}\n${functionCallsJson}`;
+    }
+    if (textContent) {
+        return textContent;
+    }
+    if (functionCallsJson) {
+        return functionCallsJson;
+    }
+    return undefined;
+}
+//# sourceMappingURL=generateContentResponseUtilities.js.map

package/dist/src/utils/generateContentResponseUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateContentResponseUtilities.js","sourceRoot":"","sources":["../../../src/utils/generateContentResponseUtilities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAOH,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,MAAM,UAAU,wBAAwB,CAAC,KAAa;IACpD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,YAAY,GAAG,KAAK;SACvB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;SACxB,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;IAE9D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,QAAiC;IAEjC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC;IACvD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,iBAAiB,GAAG,KAAK;SAC5B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;SACrC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAA4B,CAAC,CAAC;IACpD,OAAO,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,KAAa;IAEb,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,iBAAiB,GAAG,KAAK;SAC5B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;SACrC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAA4B,CAAC,CAAC;IACpD,OAAO,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,QAAiC;IAEjC,MAAM,aAAa,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACjD,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC7C,KAAa;IAEb,MAAM,aAAa,GAAG,yBAAyB,CAAC,KAAK,CAAC,CAAC;IACvD,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,QAAiC;IAEjC,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IAC9C,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAE3D,IAAI,WAAW,IAAI,iBAAiB,EAAE,CAAC;QACrC,OAAO,GAAG,WAAW,KAAK,iBAAiB,EAAE,CAAC;IAChD,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC5C,KAAa;IAEb,MAAM,WAAW,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,iBAAiB,GAAG,+BAA+B,CAAC,KAAK,CAAC,CAAC;IAEjE,IAAI,WAAW,IAAI,iBAAiB,EAAE,CAAC;QACrC,OAAO,GAAG,WAAW,KAAK,iBAAiB,EAAE,CAAC;IAChD,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/src/utils/generateContentResponseUtilities.test.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

package/dist/src/utils/generateContentResponseUtilities.test.js

@@ -0,0 +1,235 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { describe, it, expect } from 'vitest';
+import { getResponseTextFromParts, getFunctionCalls, getFunctionCallsFromParts, getFunctionCallsAsJson, getFunctionCallsFromPartsAsJson, getStructuredResponse, getStructuredResponseFromParts, } from './generateContentResponseUtilities.js';
+import { FinishReason } from '@google/genai';
+const mockTextPart = (text) => ({ text });
+const mockFunctionCallPart = (name, args) => ({
+    functionCall: { name, args: args ?? {} },
+});
+const mockResponse = (parts, finishReason = FinishReason.STOP, safetyRatings = []) => ({
+    candidates: [
+        {
+            content: {
+                parts,
+                role: 'model',
+            },
+            index: 0,
+            finishReason,
+            safetyRatings,
+        },
+    ],
+    promptFeedback: {
+        safetyRatings: [],
+    },
+    text: undefined,
+    data: undefined,
+    functionCalls: undefined,
+    executableCode: undefined,
+    codeExecutionResult: undefined,
+});
+const minimalMockResponse = (candidates) => ({
+    candidates,
+    promptFeedback: { safetyRatings: [] },
+    text: undefined,
+    data: undefined,
+    functionCalls: undefined,
+    executableCode: undefined,
+    codeExecutionResult: undefined,
+});
+describe('generateContentResponseUtilities', () => {
+    describe('getResponseTextFromParts', () => {
+        it('should return undefined for no parts', () => {
+            expect(getResponseTextFromParts([])).toBeUndefined();
+        });
+        it('should extract text from a single text part', () => {
+            expect(getResponseTextFromParts([mockTextPart('Hello')])).toBe('Hello');
+        });
+        it('should concatenate text from multiple text parts', () => {
+            expect(getResponseTextFromParts([
+                mockTextPart('Hello '),
+                mockTextPart('World'),
+            ])).toBe('Hello World');
+        });
+        it('should ignore function call parts', () => {
+            expect(getResponseTextFromParts([
+                mockTextPart('Hello '),
+                mockFunctionCallPart('testFunc'),
+                mockTextPart('World'),
+            ])).toBe('Hello World');
+        });
+        it('should return undefined if only function call parts exist', () => {
+            expect(getResponseTextFromParts([
+                mockFunctionCallPart('testFunc'),
+                mockFunctionCallPart('anotherFunc'),
+            ])).toBeUndefined();
+        });
+    });
+    describe('getFunctionCalls', () => {
+        it('should return undefined for no candidates', () => {
+            expect(getFunctionCalls(minimalMockResponse(undefined))).toBeUndefined();
+        });
+        it('should return undefined for empty candidates array', () => {
+            expect(getFunctionCalls(minimalMockResponse([]))).toBeUndefined();
+        });
+        it('should return undefined for no parts', () => {
+            const response = mockResponse([]);
+            expect(getFunctionCalls(response)).toBeUndefined();
+        });
+        it('should extract a single function call', () => {
+            const func = { name: 'testFunc', args: { a: 1 } };
+            const response = mockResponse([
+                mockFunctionCallPart(func.name, func.args),
+            ]);
+            expect(getFunctionCalls(response)).toEqual([func]);
+        });
+        it('should extract multiple function calls', () => {
+            const func1 = { name: 'testFunc1', args: { a: 1 } };
+            const func2 = { name: 'testFunc2', args: { b: 2 } };
+            const response = mockResponse([
+                mockFunctionCallPart(func1.name, func1.args),
+                mockFunctionCallPart(func2.name, func2.args),
+            ]);
+            expect(getFunctionCalls(response)).toEqual([func1, func2]);
+        });
+        it('should ignore text parts', () => {
+            const func = { name: 'testFunc', args: { a: 1 } };
+            const response = mockResponse([
+                mockTextPart('Some text'),
+                mockFunctionCallPart(func.name, func.args),
+                mockTextPart('More text'),
+            ]);
+            expect(getFunctionCalls(response)).toEqual([func]);
+        });
+        it('should return undefined if only text parts exist', () => {
+            const response = mockResponse([
+                mockTextPart('Some text'),
+                mockTextPart('More text'),
+            ]);
+            expect(getFunctionCalls(response)).toBeUndefined();
+        });
+    });
+    describe('getFunctionCallsFromParts', () => {
+        it('should return undefined for no parts', () => {
+            expect(getFunctionCallsFromParts([])).toBeUndefined();
+        });
+        it('should extract a single function call', () => {
+            const func = { name: 'testFunc', args: { a: 1 } };
+            expect(getFunctionCallsFromParts([mockFunctionCallPart(func.name, func.args)])).toEqual([func]);
+        });
+        it('should extract multiple function calls', () => {
+            const func1 = { name: 'testFunc1', args: { a: 1 } };
+            const func2 = { name: 'testFunc2', args: { b: 2 } };
+            expect(getFunctionCallsFromParts([
+                mockFunctionCallPart(func1.name, func1.args),
+                mockFunctionCallPart(func2.name, func2.args),
+            ])).toEqual([func1, func2]);
+        });
+        it('should ignore text parts', () => {
+            const func = { name: 'testFunc', args: { a: 1 } };
+            expect(getFunctionCallsFromParts([
+                mockTextPart('Some text'),
+                mockFunctionCallPart(func.name, func.args),
+                mockTextPart('More text'),
+            ])).toEqual([func]);
+        });
+        it('should return undefined if only text parts exist', () => {
+            expect(getFunctionCallsFromParts([
+                mockTextPart('Some text'),
+                mockTextPart('More text'),
+            ])).toBeUndefined();
+        });
+    });
+    describe('getFunctionCallsAsJson', () => {
+        it('should return JSON string of function calls', () => {
+            const func1 = { name: 'testFunc1', args: { a: 1 } };
+            const func2 = { name: 'testFunc2', args: { b: 2 } };
+            const response = mockResponse([
+                mockFunctionCallPart(func1.name, func1.args),
+                mockTextPart('text in between'),
+                mockFunctionCallPart(func2.name, func2.args),
+            ]);
+            const expectedJson = JSON.stringify([func1, func2], null, 2);
+            expect(getFunctionCallsAsJson(response)).toBe(expectedJson);
+        });
+        it('should return undefined if no function calls', () => {
+            const response = mockResponse([mockTextPart('Hello')]);
+            expect(getFunctionCallsAsJson(response)).toBeUndefined();
+        });
+    });
+    describe('getFunctionCallsFromPartsAsJson', () => {
+        it('should return JSON string of function calls from parts', () => {
+            const func1 = { name: 'testFunc1', args: { a: 1 } };
+            const func2 = { name: 'testFunc2', args: { b: 2 } };
+            const parts = [
+                mockFunctionCallPart(func1.name, func1.args),
+                mockTextPart('text in between'),
+                mockFunctionCallPart(func2.name, func2.args),
+            ];
+            const expectedJson = JSON.stringify([func1, func2], null, 2);
+            expect(getFunctionCallsFromPartsAsJson(parts)).toBe(expectedJson);
+        });
+        it('should return undefined if no function calls in parts', () => {
+            const parts = [mockTextPart('Hello')];
+            expect(getFunctionCallsFromPartsAsJson(parts)).toBeUndefined();
+        });
+    });
+    describe('getStructuredResponse', () => {
+        it('should return only text if only text exists', () => {
+            const response = mockResponse([mockTextPart('Hello World')]);
+            expect(getStructuredResponse(response)).toBe('Hello World');
+        });
+        it('should return only function call JSON if only function calls exist', () => {
+            const func = { name: 'testFunc', args: { data: 'payload' } };
+            const response = mockResponse([
+                mockFunctionCallPart(func.name, func.args),
+            ]);
+            const expectedJson = JSON.stringify([func], null, 2);
+            expect(getStructuredResponse(response)).toBe(expectedJson);
+        });
+        it('should return text and function call JSON if both exist', () => {
+            const text = 'Consider this data:';
+            const func = { name: 'processData', args: { item: 42 } };
+            const response = mockResponse([
+                mockTextPart(text),
+                mockFunctionCallPart(func.name, func.args),
+            ]);
+            const expectedJson = JSON.stringify([func], null, 2);
+            expect(getStructuredResponse(response)).toBe(`${text}\n${expectedJson}`);
+        });
+        it('should return undefined if neither text nor function calls exist', () => {
+            const response = mockResponse([]);
+            expect(getStructuredResponse(response)).toBeUndefined();
+        });
+    });
+    describe('getStructuredResponseFromParts', () => {
+        it('should return only text if only text exists in parts', () => {
+            const parts = [mockTextPart('Hello World')];
+            expect(getStructuredResponseFromParts(parts)).toBe('Hello World');
+        });
+        it('should return only function call JSON if only function calls exist in parts', () => {
+            const func = { name: 'testFunc', args: { data: 'payload' } };
+            const parts = [mockFunctionCallPart(func.name, func.args)];
+            const expectedJson = JSON.stringify([func], null, 2);
+            expect(getStructuredResponseFromParts(parts)).toBe(expectedJson);
+        });
+        it('should return text and function call JSON if both exist in parts', () => {
+            const text = 'Consider this data:';
+            const func = { name: 'processData', args: { item: 42 } };
+            const parts = [
+                mockTextPart(text),
+                mockFunctionCallPart(func.name, func.args),
+            ];
+            const expectedJson = JSON.stringify([func], null, 2);
+            expect(getStructuredResponseFromParts(parts)).toBe(`${text}\n${expectedJson}`);
+        });
+        it('should return undefined if neither text nor function calls exist in parts', () => {
+            const parts = [];
+            expect(getStructuredResponseFromParts(parts)).toBeUndefined();
+        });
+    });
+});
+//# sourceMappingURL=generateContentResponseUtilities.test.js.map

package/dist/src/utils/generateContentResponseUtilities.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateContentResponseUtilities.test.js","sourceRoot":"","sources":["../../../src/utils/generateContentResponseUtilities.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,gBAAgB,EAChB,yBAAyB,EACzB,sBAAsB,EACtB,+BAA+B,EAC/B,qBAAqB,EACrB,8BAA8B,GAC/B,MAAM,uCAAuC,CAAC;AAM/C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,YAAY,GAAG,CAAC,IAAY,EAAQ,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AACxD,MAAM,oBAAoB,GAAG,CAC3B,IAAY,EACZ,IAA8B,EACxB,EAAE,CAAC,CAAC;IACV,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CACnB,KAAa,EACb,eAA6B,YAAY,CAAC,IAAI,EAC9C,gBAAgC,EAAE,EACT,EAAE,CAAC,CAAC;IAC7B,UAAU,EAAE;QACV;YACE,OAAO,EAAE;gBACP,KAAK;gBACL,IAAI,EAAE,OAAO;aACd;YACD,KAAK,EAAE,CAAC;YACR,YAAY;YACZ,aAAa;SACd;KACF;IACD,cAAc,EAAE;QACd,aAAa,EAAE,EAAE;KAClB;IACD,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,SAAS;IACf,aAAa,EAAE,SAAS;IACxB,cAAc,EAAE,SAAS;IACzB,mBAAmB,EAAE,SAAS;CAC/B,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,CAC1B,UAAiD,EACxB,EAAE,CAAC,CAAC;IAC7B,UAAU;IACV,cAAc,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE;IACrC,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,SAAS;IACf,aAAa,EAAE,SAAS;IACxB,cAAc,EAAE,SAAS;IACzB,mBAAmB,EAAE,SAAS;CAC/B,CAAC,CAAC;AAEH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACvD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,CAAC,wBAAwB,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,CACJ,wBAAwB,CAAC;gBACvB,YAAY,CAAC,QAAQ,CAAC;gBACtB,YAAY,CAAC,OAAO,CAAC;aACtB,CAAC,CACH,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,CACJ,wBAAwB,CAAC;gBACvB,YAAY,CAAC,QAAQ,CAAC;gBACtB,oBAAoB,CAAC,UAAU,CAAC;gBAChC,YAAY,CAAC,OAAO,CAAC;aACtB,CAAC,CACH,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,CACJ,wBAAwB,CAAC;gBACvB,oBAAoB,CAAC,UAAU,CAAC;gBAChC,oBAAoB,CAAC,aAAa,CAAC;aACpC,CAAC,CACH,CAAC,aAAa,EAAE,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QAC3E,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;YAClC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,QAAQ,GAAG,YAAY,CAAC;gBAC5B,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;aAC3C,CAAC,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,QAAQ,GAAG,YAAY,CAAC;gBAC5B,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;gBAC5C,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;aAC7C,CAAC,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,QAAQ,GAAG,YAAY,CAAC;gBAC5B,YAAY,CAAC,WAAW,CAAC;gBACzB,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;gBAC1C,YAAY,CAAC,WAAW,CAAC;aAC1B,CAAC,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC;gBAC5B,YAAY,CAAC,WAAW,CAAC;gBACzB,YAAY,CAAC,WAAW,CAAC;aAC1B,CAAC,CAAC;YACH,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACxD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,CACJ,yBAAyB,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CACxE,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,CACJ,yBAAyB,CAAC;gBACxB,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;gBAC5C,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;aAC7C,CAAC,CACH,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,CACJ,yBAAyB,CAAC;gBACxB,YAAY,CAAC,WAAW,CAAC;gBACzB,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;gBAC1C,YAAY,CAAC,WAAW,CAAC;aAC1B,CAAC,CACH,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,CACJ,yBAAyB,CAAC;gBACxB,YAAY,CAAC,WAAW,CAAC;gBACzB,YAAY,CAAC,WAAW,CAAC;aAC1B,CAAC,CACH,CAAC,aAAa,EAAE,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,QAAQ,GAAG,YAAY,CAAC;gBAC5B,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;gBAC5C,YAAY,CAAC,iBAAiB,CAAC;gBAC/B,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;aAC7C,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC7D,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;QAC/C,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,KAAK,GAAG;gBACZ,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;gBAC5C,YAAY,CAAC,iBAAiB,CAAC;gBAC/B,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;aAC7C,CAAC;YACF,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC7D,MAAM,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACjE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YAC7D,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;YAC5E,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC;YAC7D,MAAM,QAAQ,GAAG,YAAY,CAAC;gBAC5B,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;aAC3C,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACjE,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC;YACzD,MAAM,QAAQ,GAAG,YAAY,CAAC;gBAC5B,YAAY,CAAC,IAAI,CAAC;gBAClB,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;aAC3C,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,YAAY,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;YAC1E,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;YAClC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;QAC9C,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;YAC5C,MAAM,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;YACrF,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC;YAC7D,MAAM,KAAK,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC3D,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;YAC1E,MAAM,IAAI,GAAG,qBAAqB,CAAC;YACnC,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC;YACzD,MAAM,KAAK,GAAG;gBACZ,YAAY,CAAC,IAAI,CAAC;gBAClB,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;aAC3C,CAAC;YACF,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAChD,GAAG,IAAI,KAAK,YAAY,EAAE,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;YACnF,MAAM,KAAK,GAAW,EAAE,CAAC;YACzB,MAAM,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/utils/getFolderStructure.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { FileDiscoveryService } from '../services/fileDiscoveryService.js';
+import type { FileFilteringOptions } from '../config/constants.js';
+/** Options for customizing folder structure retrieval. */
+interface FolderStructureOptions {
+    /** Maximum number of files and folders combined to display. Defaults to 20. */
+    maxItems?: number;
+    /** Set of folder names to ignore completely. Case-sensitive. */
+    ignoredFolders?: Set<string>;
+    /** Optional regex to filter included files by name. */
+    fileIncludePattern?: RegExp;
+    /** For filtering files. */
+    fileService?: FileDiscoveryService;
+    /** File filtering ignore options. */
+    fileFilteringOptions?: FileFilteringOptions;
+}
+/**
+ * Generates a string representation of a directory's structure,
+ * limiting the number of items displayed. Ignored folders are shown
+ * followed by '...' instead of their contents.
+ *
+ * @param directory The absolute or relative path to the directory.
+ * @param options Optional configuration settings.
+ * @returns A promise resolving to the formatted folder structure string.
+ */
+export declare function getFolderStructure(directory: string, options?: FolderStructureOptions): Promise<string>;
+export {};

package/dist/src/utils/getFolderStructure.js

@@ -0,0 +1,246 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import { getErrorMessage, isNodeError } from './errors.js';
+import { DEFAULT_FILE_FILTERING_OPTIONS } from '../config/constants.js';
+const MAX_ITEMS = 20;
+const TRUNCATION_INDICATOR = '...';
+const DEFAULT_IGNORED_FOLDERS = new Set(['node_modules', '.git', 'dist']);
+// --- Interfaces ---
+// --- Helper Functions ---
+async function readFullStructure(rootPath, options) {
+    const rootName = path.basename(rootPath);
+    const rootNode = {
+        name: rootName,
+        path: rootPath,
+        files: [],
+        subFolders: [],
+        totalChildren: 0,
+        totalFiles: 0,
+    };
+    const queue = [
+        { folderInfo: rootNode, currentPath: rootPath },
+    ];
+    let currentItemCount = 0;
+    // Count the root node itself as one item if we are not just listing its content
+    const processedPaths = new Set(); // To avoid processing same path if symlinks create loops
+    while (queue.length > 0) {
+        const { folderInfo, currentPath } = queue.shift();
+        if (processedPaths.has(currentPath)) {
+            continue;
+        }
+        processedPaths.add(currentPath);
+        if (currentItemCount >= options.maxItems) {
+            // If the root itself caused us to exceed, we can't really show anything.
+            // Otherwise, this folder won't be processed further.
+            // The parent that queued this would have set its own hasMoreSubfolders flag.
+            continue;
+        }
+        let entries;
+        try {
+            const rawEntries = await fs.readdir(currentPath, { withFileTypes: true });
+            // Sort entries alphabetically by name for consistent processing order
+            entries = rawEntries.sort((a, b) => a.name.localeCompare(b.name));
+        }
+        catch (error) {
+            if (isNodeError(error) &&
+                (error.code === 'EACCES' || error.code === 'ENOENT')) {
+                console.warn(`Warning: Could not read directory ${currentPath}: ${error.message}`);
+                if (currentPath === rootPath && error.code === 'ENOENT') {
+                    return null; // Root directory itself not found
+                }
+                // For other EACCES/ENOENT on subdirectories, just skip them.
+                continue;
+            }
+            throw error;
+        }
+        const filesInCurrentDir = [];
+        const subFoldersInCurrentDir = [];
+        // Process files first in the current directory
+        for (const entry of entries) {
+            if (entry.isFile()) {
+                if (currentItemCount >= options.maxItems) {
+                    folderInfo.hasMoreFiles = true;
+                    break;
+                }
+                const fileName = entry.name;
+                const filePath = path.join(currentPath, fileName);
+                if (options.fileService) {
+                    const shouldIgnore = (options.fileFilteringOptions.respectGitIgnore &&
+                        options.fileService.shouldGitIgnoreFile(filePath)) ||
+                        (options.fileFilteringOptions.respectQwenIgnore &&
+                            options.fileService.shouldQwenIgnoreFile(filePath));
+                    if (shouldIgnore) {
+                        continue;
+                    }
+                }
+                if (!options.fileIncludePattern ||
+                    options.fileIncludePattern.test(fileName)) {
+                    filesInCurrentDir.push(fileName);
+                    currentItemCount++;
+                    folderInfo.totalFiles++;
+                    folderInfo.totalChildren++;
+                }
+            }
+        }
+        folderInfo.files = filesInCurrentDir;
+        // Then process directories and queue them
+        for (const entry of entries) {
+            if (entry.isDirectory()) {
+                // Check if adding this directory ITSELF would meet or exceed maxItems
+                // (currentItemCount refers to items *already* added before this one)
+                if (currentItemCount >= options.maxItems) {
+                    folderInfo.hasMoreSubfolders = true;
+                    break; // Already at limit, cannot add this folder or any more
+                }
+                // If adding THIS folder makes us hit the limit exactly, and it might have children,
+                // it's better to show '...' for the parent, unless this is the very last item slot.
+                // This logic is tricky. Let's try a simpler: if we can't add this item, mark and break.
+                const subFolderName = entry.name;
+                const subFolderPath = path.join(currentPath, subFolderName);
+                let isIgnored = false;
+                if (options.fileService) {
+                    isIgnored =
+                        (options.fileFilteringOptions.respectGitIgnore &&
+                            options.fileService.shouldGitIgnoreFile(subFolderPath)) ||
+                            (options.fileFilteringOptions.respectQwenIgnore &&
+                                options.fileService.shouldQwenIgnoreFile(subFolderPath));
+                }
+                if (options.ignoredFolders.has(subFolderName) || isIgnored) {
+                    const ignoredSubFolder = {
+                        name: subFolderName,
+                        path: subFolderPath,
+                        files: [],
+                        subFolders: [],
+                        totalChildren: 0,
+                        totalFiles: 0,
+                        isIgnored: true,
+                    };
+                    subFoldersInCurrentDir.push(ignoredSubFolder);
+                    currentItemCount++; // Count the ignored folder itself
+                    folderInfo.totalChildren++; // Also counts towards parent's children
+                    continue;
+                }
+                const subFolderNode = {
+                    name: subFolderName,
+                    path: subFolderPath,
+                    files: [],
+                    subFolders: [],
+                    totalChildren: 0,
+                    totalFiles: 0,
+                };
+                subFoldersInCurrentDir.push(subFolderNode);
+                currentItemCount++;
+                folderInfo.totalChildren++; // Counts towards parent's children
+                // Add to queue for processing its children later
+                queue.push({ folderInfo: subFolderNode, currentPath: subFolderPath });
+            }
+        }
+        folderInfo.subFolders = subFoldersInCurrentDir;
+    }
+    return rootNode;
+}
+/**
+ * Reads the directory structure using BFS, respecting maxItems.
+ * @param node The current node in the reduced structure.
+ * @param indent The current indentation string.
+ * @param isLast Sibling indicator.
+ * @param builder Array to build the string lines.
+ */
+function formatStructure(node, currentIndent, isLastChildOfParent, isProcessingRootNode, builder) {
+    const connector = isLastChildOfParent ? '└───' : '├───';
+    // The root node of the structure (the one passed initially to getFolderStructure)
+    // is not printed with a connector line itself, only its name as a header.
+    // Its children are printed relative to that conceptual root.
+    // Ignored root nodes ARE printed with a connector.
+    if (!isProcessingRootNode || node.isIgnored) {
+        builder.push(`${currentIndent}${connector}${node.name}${path.sep}${node.isIgnored ? TRUNCATION_INDICATOR : ''}`);
+    }
+    // Determine the indent for the children of *this* node.
+    // If *this* node was the root of the whole structure, its children start with no indent before their connectors.
+    // Otherwise, children's indent extends from the current node's indent.
+    const indentForChildren = isProcessingRootNode
+        ? ''
+        : currentIndent + (isLastChildOfParent ? '    ' : '│   ');
+    // Render files of the current node
+    const fileCount = node.files.length;
+    for (let i = 0; i < fileCount; i++) {
+        const isLastFileAmongSiblings = i === fileCount - 1 &&
+            node.subFolders.length === 0 &&
+            !node.hasMoreSubfolders;
+        const fileConnector = isLastFileAmongSiblings ? '└───' : '├───';
+        builder.push(`${indentForChildren}${fileConnector}${node.files[i]}`);
+    }
+    if (node.hasMoreFiles) {
+        const isLastIndicatorAmongSiblings = node.subFolders.length === 0 && !node.hasMoreSubfolders;
+        const fileConnector = isLastIndicatorAmongSiblings ? '└───' : '├───';
+        builder.push(`${indentForChildren}${fileConnector}${TRUNCATION_INDICATOR}`);
+    }
+    // Render subfolders of the current node
+    const subFolderCount = node.subFolders.length;
+    for (let i = 0; i < subFolderCount; i++) {
+        const isLastSubfolderAmongSiblings = i === subFolderCount - 1 && !node.hasMoreSubfolders;
+        // Children are never the root node being processed initially.
+        formatStructure(node.subFolders[i], indentForChildren, isLastSubfolderAmongSiblings, false, builder);
+    }
+    if (node.hasMoreSubfolders) {
+        builder.push(`${indentForChildren}└───${TRUNCATION_INDICATOR}`);
+    }
+}
+// --- Main Exported Function ---
+/**
+ * Generates a string representation of a directory's structure,
+ * limiting the number of items displayed. Ignored folders are shown
+ * followed by '...' instead of their contents.
+ *
+ * @param directory The absolute or relative path to the directory.
+ * @param options Optional configuration settings.
+ * @returns A promise resolving to the formatted folder structure string.
+ */
+export async function getFolderStructure(directory, options) {
+    const resolvedPath = path.resolve(directory);
+    const mergedOptions = {
+        maxItems: options?.maxItems ?? MAX_ITEMS,
+        ignoredFolders: options?.ignoredFolders ?? DEFAULT_IGNORED_FOLDERS,
+        fileIncludePattern: options?.fileIncludePattern,
+        fileService: options?.fileService,
+        fileFilteringOptions: options?.fileFilteringOptions ?? DEFAULT_FILE_FILTERING_OPTIONS,
+    };
+    try {
+        // 1. Read the structure using BFS, respecting maxItems
+        const structureRoot = await readFullStructure(resolvedPath, mergedOptions);
+        if (!structureRoot) {
+            return `Error: Could not read directory "${resolvedPath}". Check path and permissions.`;
+        }
+        // 2. Format the structure into a string
+        const structureLines = [];
+        // Pass true for isRoot for the initial call
+        formatStructure(structureRoot, '', true, true, structureLines);
+        // 3. Build the final output string
+        function isTruncated(node) {
+            if (node.hasMoreFiles || node.hasMoreSubfolders || node.isIgnored) {
+                return true;
+            }
+            for (const sub of node.subFolders) {
+                if (isTruncated(sub)) {
+                    return true;
+                }
+            }
+            return false;
+        }
+        let summary = `Showing up to ${mergedOptions.maxItems} items (files + folders).`;
+        if (isTruncated(structureRoot)) {
+            summary += ` Folders or files indicated with ${TRUNCATION_INDICATOR} contain more items not shown, were ignored, or the display limit (${mergedOptions.maxItems} items) was reached.`;
+        }
+        return `${summary}\n\n${resolvedPath}${path.sep}\n${structureLines.join('\n')}`;
+    }
+    catch (error) {
+        console.error(`Error getting folder structure for ${resolvedPath}:`, error);
+        return `Error processing directory "${resolvedPath}": ${getErrorMessage(error)}`;
+    }
+}
+//# sourceMappingURL=getFolderStructure.js.map

package/dist/src/utils/getFolderStructure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFolderStructure.js","sourceRoot":"","sources":["../../../src/utils/getFolderStructure.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG3D,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AAExE,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,oBAAoB,GAAG,KAAK,CAAC;AACnC,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAuC1E,qBAAqB;AAErB,2BAA2B;AAE3B,KAAK,UAAU,iBAAiB,CAC9B,QAAgB,EAChB,OAAqC;IAErC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAmB;QAC/B,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,EAAE;QACT,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,CAAC;QAChB,UAAU,EAAE,CAAC;KACd,CAAC;IAEF,MAAM,KAAK,GAA+D;QACxE,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE;KAChD,CAAC;IACF,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,gFAAgF;IAEhF,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC,CAAC,yDAAyD;IAEnG,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QAEnD,IAAI,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YACpC,SAAS;QACX,CAAC;QACD,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,gBAAgB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACzC,yEAAyE;YACzE,qDAAqD;YACrD,6EAA6E;YAC7E,SAAS;QACX,CAAC;QAED,IAAI,OAAiB,CAAC;QACtB,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1E,sEAAsE;YACtE,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IACE,WAAW,CAAC,KAAK,CAAC;gBAClB,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,EACpD,CAAC;gBACD,OAAO,CAAC,IAAI,CACV,qCAAqC,WAAW,KAAK,KAAK,CAAC,OAAO,EAAE,CACrE,CAAC;gBACF,IAAI,WAAW,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACxD,OAAO,IAAI,CAAC,CAAC,kCAAkC;gBACjD,CAAC;gBACD,6DAA6D;gBAC7D,SAAS;YACX,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,MAAM,sBAAsB,GAAqB,EAAE,CAAC;QAEpD,+CAA+C;QAC/C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;gBACnB,IAAI,gBAAgB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACzC,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC;oBAC/B,MAAM;gBACR,CAAC;gBACD,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC;gBAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;gBAClD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACxB,MAAM,YAAY,GAChB,CAAC,OAAO,CAAC,oBAAoB,CAAC,gBAAgB;wBAC5C,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;wBACpD,CAAC,OAAO,CAAC,oBAAoB,CAAC,iBAAiB;4BAC7C,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACxD,IAAI,YAAY,EAAE,CAAC;wBACjB,SAAS;oBACX,CAAC;gBACH,CAAC;gBACD,IACE,CAAC,OAAO,CAAC,kBAAkB;oBAC3B,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EACzC,CAAC;oBACD,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACjC,gBAAgB,EAAE,CAAC;oBACnB,UAAU,CAAC,UAAU,EAAE,CAAC;oBACxB,UAAU,CAAC,aAAa,EAAE,CAAC;gBAC7B,CAAC;YACH,CAAC;QACH,CAAC;QACD,UAAU,CAAC,KAAK,GAAG,iBAAiB,CAAC;QAErC,0CAA0C;QAC1C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,sEAAsE;gBACtE,qEAAqE;gBACrE,IAAI,gBAAgB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACzC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC;oBACpC,MAAM,CAAC,uDAAuD;gBAChE,CAAC;gBACD,oFAAoF;gBACpF,oFAAoF;gBACpF,wFAAwF;gBAExF,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC;gBACjC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;gBAE5D,IAAI,SAAS,GAAG,KAAK,CAAC;gBACtB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACxB,SAAS;wBACP,CAAC,OAAO,CAAC,oBAAoB,CAAC,gBAAgB;4BAC5C,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;4BACzD,CAAC,OAAO,CAAC,oBAAoB,CAAC,iBAAiB;gCAC7C,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC;gBAC/D,CAAC;gBAED,IAAI,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,SAAS,EAAE,CAAC;oBAC3D,MAAM,gBAAgB,GAAmB;wBACvC,IAAI,EAAE,aAAa;wBACnB,IAAI,EAAE,aAAa;wBACnB,KAAK,EAAE,EAAE;wBACT,UAAU,EAAE,EAAE;wBACd,aAAa,EAAE,CAAC;wBAChB,UAAU,EAAE,CAAC;wBACb,SAAS,EAAE,IAAI;qBAChB,CAAC;oBACF,sBAAsB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;oBAC9C,gBAAgB,EAAE,CAAC,CAAC,kCAAkC;oBACtD,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC,wCAAwC;oBACpE,SAAS;gBACX,CAAC;gBAED,MAAM,aAAa,GAAmB;oBACpC,IAAI,EAAE,aAAa;oBACnB,IAAI,EAAE,aAAa;oBACnB,KAAK,EAAE,EAAE;oBACT,UAAU,EAAE,EAAE;oBACd,aAAa,EAAE,CAAC;oBAChB,UAAU,EAAE,CAAC;iBACd,CAAC;gBACF,sBAAsB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC3C,gBAAgB,EAAE,CAAC;gBACnB,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC,mCAAmC;gBAE/D,iDAAiD;gBACjD,KAAK,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;QACD,UAAU,CAAC,UAAU,GAAG,sBAAsB,CAAC;IACjD,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CACtB,IAAoB,EACpB,aAAqB,EACrB,mBAA4B,EAC5B,oBAA6B,EAC7B,OAAiB;IAEjB,MAAM,SAAS,GAAG,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;IAExD,kFAAkF;IAClF,0EAA0E;IAC1E,6DAA6D;IAC7D,mDAAmD;IACnD,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QAC5C,OAAO,CAAC,IAAI,CACV,GAAG,aAAa,GAAG,SAAS,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,EAAE,CACnG,CAAC;IACJ,CAAC;IAED,wDAAwD;IACxD,iHAAiH;IACjH,uEAAuE;IACvE,MAAM,iBAAiB,GAAG,oBAAoB;QAC5C,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,aAAa,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAE5D,mCAAmC;IACnC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,uBAAuB,GAC3B,CAAC,KAAK,SAAS,GAAG,CAAC;YACnB,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;YAC5B,CAAC,IAAI,CAAC,iBAAiB,CAAC;QAC1B,MAAM,aAAa,GAAG,uBAAuB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QAChE,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,GAAG,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,MAAM,4BAA4B,GAChC,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC;QAC1D,MAAM,aAAa,GAAG,4BAA4B,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QACrE,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,GAAG,aAAa,GAAG,oBAAoB,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,wCAAwC;IACxC,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,4BAA4B,GAChC,CAAC,KAAK,cAAc,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC;QACtD,8DAA8D;QAC9D,eAAe,CACb,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAClB,iBAAiB,EACjB,4BAA4B,EAC5B,KAAK,EACL,OAAO,CACR,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,OAAO,oBAAoB,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED,iCAAiC;AAEjC;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,SAAiB,EACjB,OAAgC;IAEhC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAiC;QAClD,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,SAAS;QACxC,cAAc,EAAE,OAAO,EAAE,cAAc,IAAI,uBAAuB;QAClE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;QAC/C,WAAW,EAAE,OAAO,EAAE,WAAW;QACjC,oBAAoB,EAClB,OAAO,EAAE,oBAAoB,IAAI,8BAA8B;KAClE,CAAC;IAEF,IAAI,CAAC;QACH,uDAAuD;QACvD,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAE3E,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,oCAAoC,YAAY,gCAAgC,CAAC;QAC1F,CAAC;QAED,wCAAwC;QACxC,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,4CAA4C;QAC5C,eAAe,CAAC,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;QAE/D,mCAAmC;QACnC,SAAS,WAAW,CAAC,IAAoB;YACvC,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBAClE,OAAO,IAAI,CAAC;YACd,CAAC;YACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClC,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;oBACrB,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,OAAO,GAAG,iBAAiB,aAAa,CAAC,QAAQ,2BAA2B,CAAC;QAEjF,IAAI,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/B,OAAO,IAAI,oCAAoC,oBAAoB,sEAAsE,aAAa,CAAC,QAAQ,sBAAsB,CAAC;QACxL,CAAC;QAED,OAAO,GAAG,OAAO,OAAO,YAAY,GAAG,IAAI,CAAC,GAAG,KAAK,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAClF,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,sCAAsC,YAAY,GAAG,EAAE,KAAK,CAAC,CAAC;QAC5E,OAAO,+BAA+B,YAAY,MAAM,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IACnF,CAAC;AACH,CAAC"}