@gyomu/ai-compiler 0.2.4-beta.5

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.d.ts

@@ -0,0 +1,2 @@
+import 'dotenv/config';
+//# sourceMappingURL=documentable-child-members.d.ts.map

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentable-child-members.d.ts","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/documentable-child-members.ts"],"names":[],"mappings":"AAMA,OAAO,eAAe,CAAA"}

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.js

@@ -0,0 +1,67 @@
+import { describe, expect, test } from 'vitest';
+import { Layer } from 'effect';
+import { ConfigLayer, MainLayer, PlatformLayer } from '@gyomu/infra';
+import { VercelAiModelServiceLive } from '@gyomu/ai/provider/vercel';
+import { makeRunner } from '@gyomu/schema/effect';
+import { executeJsDocUpdatePlan } from '../executor/executeJsDocUpdatePlan.js';
+import 'dotenv/config';
+const describeIfApiKey = process.env.GEMINI_API_KEY ? describe : describe.skip;
+const layer = Layer.provideMerge(MainLayer, ConfigLayer).pipe(Layer.provideMerge(PlatformLayer));
+const runQAWithEnvOrThrow = makeRunner(VercelAiModelServiceLive);
+describeIfApiKey('executeJsDocUpdatePlan integration', () => {
+    test('generates plans for documentable child members', async () => {
+        const context = {
+            project: { name: 'simple test' },
+            source: { relativePath: 'test/user.ts' },
+            // mode: 'light',
+            symbols: [
+                {
+                    target: {
+                        symbolId: 'User',
+                        signatureId: 'interface',
+                    },
+                    symbol: {
+                        name: 'User',
+                        kind: 'interface',
+                    },
+                    code: {
+                        snippet: `
+export interface User {
+  id: string
+}
+`,
+                    },
+                    existingJsDoc: {
+                        summary: 'User information.',
+                        params: [],
+                        tags: [],
+                    },
+                    effectSignals: undefined,
+                    children: [
+                        {
+                            target: {
+                                symbolId: 'User.id',
+                                signatureId: 'property',
+                            },
+                            name: 'id',
+                            kind: 'property',
+                            existingJsDoc: {
+                                summary: 'User identifier.',
+                                params: [],
+                                tags: [],
+                            },
+                            effectSignals: undefined,
+                        },
+                    ],
+                    relatedSymbols: [],
+                },
+            ],
+        };
+        const plan = await runQAWithEnvOrThrow(executeJsDocUpdatePlan(context), layer);
+        console.dir(plan, { depth: null });
+        expect(plan.length).toBeGreaterThanOrEqual(2);
+        expect(plan.some((p) => p.identity.symbolId === 'User')).toBe(true);
+        expect(plan.some((p) => p.identity.symbolId === 'User.id')).toBe(true);
+    }, 60_000);
+});
+//# sourceMappingURL=documentable-child-members.js.map

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentable-child-members.js","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/documentable-child-members.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAA;AAC9E,OAAO,eAAe,CAAA;AAGtB,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAA;AAE9E,MAAM,KAAK,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAA;AAChG,MAAM,mBAAmB,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;AAEhE,gBAAgB,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAC1D,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,OAAO,GAAqB;YAChC,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,EAAE,YAAY,EAAE,cAAc,EAAE;YAExC,iBAAiB;YAEjB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE;wBACN,QAAQ,EAAE,MAAM;wBAChB,WAAW,EAAE,WAAW;qBACzB;oBAED,MAAM,EAAE;wBACN,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,WAAW;qBAClB;oBAED,IAAI,EAAE;wBACJ,OAAO,EAAE;;;;CAIpB;qBACU;oBAED,aAAa,EAAE;wBACb,OAAO,EAAE,mBAAmB;wBAC5B,MAAM,EAAE,EAAE;wBACV,IAAI,EAAE,EAAE;qBACT;oBACD,aAAa,EAAE,SAAS;oBACxB,QAAQ,EAAE;wBACR;4BACE,MAAM,EAAE;gCACN,QAAQ,EAAE,SAAS;gCACnB,WAAW,EAAE,UAAU;6BACxB;4BAED,IAAI,EAAE,IAAI;4BACV,IAAI,EAAE,UAAU;4BAEhB,aAAa,EAAE;gCACb,OAAO,EAAE,kBAAkB;gCAC3B,MAAM,EAAE,EAAE;gCACV,IAAI,EAAE,EAAE;6BACT;4BACD,aAAa,EAAE,SAAS;yBACzB;qBACF;oBAED,cAAc,EAAE,EAAE;iBACnB;aACF;SACF,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAElC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAA;QAE7C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACxE,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC,CAAC,CAAA"}

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.test.d.ts

@@ -0,0 +1,2 @@
+import 'dotenv/config';
+//# sourceMappingURL=documentable-child-members.test.d.ts.map

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentable-child-members.test.d.ts","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/documentable-child-members.test.ts"],"names":[],"mappings":"AAKA,OAAO,eAAe,CAAA"}

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.test.js

@@ -0,0 +1,60 @@
+import { describe, expect, test } from 'vitest';
+import { Layer } from 'effect';
+import { ConfigLayer, MainLayer, PlatformLayer, makeRunner } from '@gyomu/infra';
+import { VercelAiModelServiceLive } from '@gyomu/ai/provider/vercel';
+import { executeJsDocUpdatePlan } from '../executor/executeJsDocUpdatePlan.js';
+import 'dotenv/config';
+const describeIfApiKey = process.env.GEMINI_API_KEY ? describe : describe.skip;
+const layer = Layer.provideMerge(MainLayer, ConfigLayer).pipe(Layer.provideMerge(PlatformLayer));
+const runQAWithEnvOrThrow = makeRunner(VercelAiModelServiceLive);
+describeIfApiKey('executeJsDocUpdatePlan integration', () => {
+    test('generates plans for documentable child members', async () => {
+        const context = {
+            project: { name: 'simple test' },
+            source: { relativePath: 'test/user.ts' },
+            mode: 'light',
+            target: {
+                symbolId: 'User',
+                signatureId: 'interface',
+            },
+            symbol: {
+                name: 'User',
+                kind: 'interface',
+            },
+            code: {
+                snippet: `
+export interface User {
+  id: string
+}
+`,
+            },
+            existingJsDoc: {
+                summary: 'User information.',
+                params: [],
+                tags: [],
+            },
+            children: [
+                {
+                    id: 'User.id',
+                    name: 'id',
+                    kind: 'property',
+                    existingJsDoc: {
+                        summary: 'User identifier.',
+                        params: [],
+                        tags: [],
+                    },
+                },
+            ],
+            relatedSymbols: [],
+            options: {
+                preserveStyle: true,
+            },
+        };
+        const plan = await runQAWithEnvOrThrow(executeJsDocUpdatePlan(context), layer);
+        console.dir(plan, { depth: null });
+        expect(plan.length).toBeGreaterThanOrEqual(2);
+        expect(plan.some((p) => p.identity.symbolId === 'User')).toBe(true);
+        expect(plan.some((p) => p.identity.symbolId === 'User.id')).toBe(true);
+    }, 60_000);
+});
+//# sourceMappingURL=documentable-child-members.test.js.map

package/dist/pipelines/jsdoc-update/__sit__/documentable-child-members.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentable-child-members.test.js","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/documentable-child-members.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAChF,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAA;AAC9E,OAAO,eAAe,CAAA;AAGtB,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAA;AAE9E,MAAM,KAAK,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAA;AAChG,MAAM,mBAAmB,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;AAEhE,gBAAgB,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAC1D,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,OAAO,GAAsB;YACjC,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,EAAE,YAAY,EAAE,cAAc,EAAE;YAExC,IAAI,EAAE,OAAO;YAEb,MAAM,EAAE;gBACN,QAAQ,EAAE,MAAM;gBAChB,WAAW,EAAE,WAAW;aACzB;YAED,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW;aAClB;YAED,IAAI,EAAE;gBACJ,OAAO,EAAE;;;;CAIhB;aACM;YAED,aAAa,EAAE;gBACb,OAAO,EAAE,mBAAmB;gBAC5B,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,EAAE;aACT;YAED,QAAQ,EAAE;gBACR;oBACE,EAAE,EAAE,SAAS;oBAEb,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,UAAU;oBAEhB,aAAa,EAAE;wBACb,OAAO,EAAE,kBAAkB;wBAC3B,MAAM,EAAE,EAAE;wBACV,IAAI,EAAE,EAAE;qBACT;iBACF;aACF;YAED,cAAc,EAAE,EAAE;YAElB,OAAO,EAAE;gBACP,aAAa,EAAE,IAAI;aACpB;SACF,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAElC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAA;QAE7C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACxE,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC,CAAC,CAAA"}

package/dist/pipelines/jsdoc-update/__sit__/existing-jsdoc.test.d.ts

@@ -0,0 +1,2 @@
+import 'dotenv/config';
+//# sourceMappingURL=existing-jsdoc.test.d.ts.map

package/dist/pipelines/jsdoc-update/__sit__/existing-jsdoc.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"existing-jsdoc.test.d.ts","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/existing-jsdoc.test.ts"],"names":[],"mappings":"AAMA,OAAO,eAAe,CAAA"}

package/dist/pipelines/jsdoc-update/__sit__/existing-jsdoc.test.js

@@ -0,0 +1,175 @@
+import { describe, expect, test } from 'vitest';
+import { Layer } from 'effect';
+import { ConfigLayer, MainLayer, PlatformLayer } from '@gyomu/infra';
+import { makeRunner } from '@gyomu/schema/effect';
+import { VercelAiModelServiceLive } from '@gyomu/ai/provider/vercel';
+import { executeJsDocUpdatePlan } from '../executor/executeJsDocUpdatePlan.js';
+import 'dotenv/config';
+const describeIfApiKey = process.env.GEMINI_API_KEY ? describe : describe.skip;
+const layer = Layer.provideMerge(MainLayer, ConfigLayer).pipe(Layer.provideMerge(PlatformLayer));
+const runQAWithEnvOrThrow = makeRunner(VercelAiModelServiceLive);
+describeIfApiKey('executeJsDocUpdatePlan integration', () => {
+    test('prefers preserve when existing documentation already exists', async () => {
+        const context = {
+            project: { name: 'simple test' },
+            source: { relativePath: 'test/existing-jsdoc.ts' },
+            // mode: 'light',
+            symbols: [
+                {
+                    target: {
+                        signatureId: '(a: number, b: number) => number',
+                        symbolId: 'add',
+                    },
+                    symbol: {
+                        name: 'add',
+                        kind: 'function',
+                    },
+                    relatedSymbols: [],
+                    code: {
+                        //         declarationSnippet: `
+                        // export const add = (
+                        //   a: number,
+                        //   b: number,
+                        // ): number
+                        // `,
+                        snippet: 'return a + b',
+                    },
+                    existingJsDoc: {
+                        summary: 'Adds two numbers.',
+                        params: [
+                            {
+                                name: 'a',
+                                type: 'number',
+                                description: 'The first number.',
+                                sortOrder: 1,
+                            },
+                            {
+                                name: 'b',
+                                type: 'number',
+                                description: 'The second number.',
+                                sortOrder: 2,
+                            },
+                        ],
+                        returns: 'The sum of the two numbers.',
+                        tags: [],
+                    },
+                    effectSignals: undefined,
+                },
+            ],
+        };
+        const plan = await runQAWithEnvOrThrow(executeJsDocUpdatePlan(context), layer);
+        console.dir(plan, { depth: null });
+        expect(plan[0]?.summary.action.type).toBe('preserve');
+        expect(plan[0]?.params.every((p) => p.action.type === 'preserve')).toBe(true);
+        expect(plan[0]?.returns.action.type).toBe('preserve');
+    }, 60_000);
+    test('slightly different jsdoc expects replacement in summary', async () => {
+        const context = {
+            project: { name: 'simple test' },
+            source: { relativePath: 'test/existing-jsdoc.ts' },
+            // mode: 'light',
+            symbols: [
+                {
+                    target: {
+                        signatureId: '(a: number, b: number) => number',
+                        symbolId: 'add',
+                    },
+                    symbol: {
+                        name: 'add',
+                        kind: 'function',
+                    },
+                    relatedSymbols: [],
+                    code: {
+                        //         declarationSnippet: `
+                        // export const add = (
+                        //   a: number,
+                        //   b: number,
+                        // ): number
+                        // `,
+                        snippet: 'return a + b',
+                    },
+                    existingJsDoc: {
+                        summary: 'Adds three numbers.',
+                        params: [
+                            {
+                                name: 'a',
+                                type: 'number',
+                                description: 'The first number.',
+                                sortOrder: 1,
+                            },
+                            {
+                                name: 'b',
+                                type: 'number',
+                                description: 'The second number.',
+                                sortOrder: 2,
+                            },
+                        ],
+                        returns: 'The sum of the two numbers.',
+                        tags: [],
+                    },
+                    effectSignals: undefined,
+                },
+            ],
+        };
+        const plan = await runQAWithEnvOrThrow(executeJsDocUpdatePlan(context), layer);
+        console.dir(plan, { depth: null });
+        expect(plan[0]?.summary.action.type).toBe('replace');
+        expect(plan[0]?.params.every((p) => p.action.type === 'preserve')).toBe(true);
+        expect(plan[0]?.returns.action.type).toBe('preserve');
+    }, 60_000);
+    test('deletes parameter documentation for removed parameter', async () => {
+        const context = {
+            project: { name: 'simple test' },
+            source: { relativePath: 'test/existing-jsdoc.ts' },
+            // mode: 'light',
+            symbols: [
+                {
+                    target: {
+                        signatureId: '(a: number, b: number) => number',
+                        symbolId: 'add',
+                    },
+                    symbol: {
+                        name: 'add',
+                        kind: 'function',
+                    },
+                    relatedSymbols: [],
+                    code: {
+                        snippet: 'return a + b',
+                    },
+                    existingJsDoc: {
+                        summary: 'Adds two numbers.',
+                        params: [
+                            {
+                                name: 'a',
+                                type: 'number',
+                                description: 'The first number.',
+                                sortOrder: 1,
+                            },
+                            {
+                                name: 'b',
+                                type: 'number',
+                                description: 'The second number.',
+                                sortOrder: 2,
+                            },
+                            {
+                                name: 'removedParam',
+                                type: 'number',
+                                description: 'No longer exists.',
+                                sortOrder: 3,
+                            },
+                        ],
+                        returns: 'The sum of the two numbers.',
+                        tags: [],
+                    },
+                    effectSignals: undefined,
+                },
+            ],
+        };
+        const plan = await runQAWithEnvOrThrow(executeJsDocUpdatePlan(context), layer);
+        console.dir(plan, { depth: null });
+        const removedParamPlan = plan[0]?.params.find((p) => p.name === 'removedParam');
+        expect(removedParamPlan).toBeDefined();
+        expect(removedParamPlan?.action.type).toBe('delete');
+    }, 60_000);
+});
+//# sourceMappingURL=existing-jsdoc.test.js.map

package/dist/pipelines/jsdoc-update/__sit__/existing-jsdoc.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"existing-jsdoc.test.js","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/existing-jsdoc.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAA;AAC9E,OAAO,eAAe,CAAA;AAGtB,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAA;AAE9E,MAAM,KAAK,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAA;AAChG,MAAM,mBAAmB,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;AAEhE,gBAAgB,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAC1D,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,OAAO,GAAqB;YAChC,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,EAAE,YAAY,EAAE,wBAAwB,EAAE;YAElD,iBAAiB;YACjB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE;wBACN,WAAW,EAAE,kCAAkC;wBAC/C,QAAQ,EAAE,KAAK;qBAChB;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,KAAK;wBACX,IAAI,EAAE,UAAU;qBACjB;oBACD,cAAc,EAAE,EAAE;oBAClB,IAAI,EAAE;wBACJ,gCAAgC;wBAChC,uBAAuB;wBACvB,eAAe;wBACf,eAAe;wBACf,YAAY;wBACZ,KAAK;wBACL,OAAO,EAAE,cAAc;qBACxB;oBAED,aAAa,EAAE;wBACb,OAAO,EAAE,mBAAmB;wBAE5B,MAAM,EAAE;4BACN;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,mBAAmB;gCAChC,SAAS,EAAE,CAAC;6BACb;4BACD;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,oBAAoB;gCACjC,SAAS,EAAE,CAAC;6BACb;yBACF;wBAED,OAAO,EAAE,6BAA6B;wBAEtC,IAAI,EAAE,EAAE;qBACT;oBACD,aAAa,EAAE,SAAS;iBACzB;aACF;SACF,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAElC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAErD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE7E,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACvD,CAAC,EAAE,MAAM,CAAC,CAAA;IACV,IAAI,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,OAAO,GAAqB;YAChC,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,EAAE,YAAY,EAAE,wBAAwB,EAAE;YAElD,iBAAiB;YACjB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE;wBACN,WAAW,EAAE,kCAAkC;wBAC/C,QAAQ,EAAE,KAAK;qBAChB;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,KAAK;wBACX,IAAI,EAAE,UAAU;qBACjB;oBACD,cAAc,EAAE,EAAE;oBAClB,IAAI,EAAE;wBACJ,gCAAgC;wBAChC,uBAAuB;wBACvB,eAAe;wBACf,eAAe;wBACf,YAAY;wBACZ,KAAK;wBACL,OAAO,EAAE,cAAc;qBACxB;oBAED,aAAa,EAAE;wBACb,OAAO,EAAE,qBAAqB;wBAE9B,MAAM,EAAE;4BACN;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,mBAAmB;gCAChC,SAAS,EAAE,CAAC;6BACb;4BACD;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,oBAAoB;gCACjC,SAAS,EAAE,CAAC;6BACb;yBACF;wBAED,OAAO,EAAE,6BAA6B;wBAEtC,IAAI,EAAE,EAAE;qBACT;oBACD,aAAa,EAAE,SAAS;iBACzB;aACF;SACF,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAElC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAEpD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE7E,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACvD,CAAC,EAAE,MAAM,CAAC,CAAA;IACV,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,OAAO,GAAqB;YAChC,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,EAAE,YAAY,EAAE,wBAAwB,EAAE;YAElD,iBAAiB;YAEjB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE;wBACN,WAAW,EAAE,kCAAkC;wBAC/C,QAAQ,EAAE,KAAK;qBAChB;oBAED,MAAM,EAAE;wBACN,IAAI,EAAE,KAAK;wBACX,IAAI,EAAE,UAAU;qBACjB;oBAED,cAAc,EAAE,EAAE;oBAElB,IAAI,EAAE;wBACJ,OAAO,EAAE,cAAc;qBACxB;oBAED,aAAa,EAAE;wBACb,OAAO,EAAE,mBAAmB;wBAE5B,MAAM,EAAE;4BACN;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,mBAAmB;gCAChC,SAAS,EAAE,CAAC;6BACb;4BACD;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,oBAAoB;gCACjC,SAAS,EAAE,CAAC;6BACb;4BACD;gCACE,IAAI,EAAE,cAAc;gCACpB,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,mBAAmB;gCAChC,SAAS,EAAE,CAAC;6BACb;yBACF;wBAED,OAAO,EAAE,6BAA6B;wBAEtC,IAAI,EAAE,EAAE;qBACT;oBACD,aAAa,EAAE,SAAS;iBACzB;aACF;SACF,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAElC,MAAM,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,CAAA;QAE/E,MAAM,CAAC,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAA;QAEtC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACtD,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC,CAAC,CAAA"}

package/dist/pipelines/jsdoc-update/__sit__/simple-function.test.d.ts

@@ -0,0 +1,2 @@
+import 'dotenv/config';
+//# sourceMappingURL=simple-function.test.d.ts.map

package/dist/pipelines/jsdoc-update/__sit__/simple-function.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-function.test.d.ts","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/simple-function.test.ts"],"names":[],"mappings":"AAMA,OAAO,eAAe,CAAA"}

package/dist/pipelines/jsdoc-update/__sit__/simple-function.test.js

@@ -0,0 +1,108 @@
+import { describe, expect, test } from 'vitest';
+import { Layer } from 'effect';
+import { ConfigLayer, MainLayer, PlatformLayer } from '@gyomu/infra';
+import { VercelAiModelServiceLive } from '@gyomu/ai/provider/vercel';
+import { makeRunner } from '@gyomu/schema/effect';
+import { executeJsDocUpdatePlan } from '../executor/executeJsDocUpdatePlan.js';
+import 'dotenv/config';
+const describeIfApiKey = process.env.GEMINI_API_KEY ? describe : describe.skip;
+const layer = Layer.provideMerge(MainLayer, ConfigLayer).pipe(Layer.provideMerge(PlatformLayer));
+const runQAWithEnvOrThrow = makeRunner(VercelAiModelServiceLive);
+describeIfApiKey('executeJsDocUpdatePlan integration', () => {
+    test('generates update plan for simple function', async () => {
+        const context = {
+            project: { name: 'simple test' },
+            source: { relativePath: 'test/simple-func.ts' },
+            // mode: 'light',
+            symbols: [
+                {
+                    target: {
+                        signatureId: '(a: number, b: number) => number',
+                        symbolId: 'add',
+                    },
+                    symbol: {
+                        name: 'add',
+                        kind: 'function',
+                    },
+                    relatedSymbols: [],
+                    code: {
+                        //         declarationSnippet: `
+                        // export const add = (
+                        //   a: number,
+                        //   b: number,
+                        // ): number
+                        // `,
+                        snippet: 'return a + b',
+                    },
+                    existingJsDoc: {
+                        params: [],
+                        tags: [],
+                    },
+                    effectSignals: undefined,
+                },
+            ],
+        };
+        const plan = await runQAWithEnvOrThrow(executeJsDocUpdatePlan(context), layer);
+        console.dir(plan, { depth: null });
+        expect(plan[0]?.summary).toBeDefined();
+        expect(plan[0]?.params.length).toBe(2);
+        expect(plan[0]?.params.some((p) => p.name === 'a')).toBe(true);
+        expect(plan[0]?.params.some((p) => p.name === 'b')).toBe(true);
+        expect(plan[0]?.risk).toBeDefined();
+    }, 60_000);
+    test('prefers preserve when existing documentation already exists', async () => {
+        const context = {
+            project: { name: 'simple test' },
+            source: { relativePath: 'test/existing-jsdoc.ts' },
+            // mode: 'light',
+            symbols: [
+                {
+                    target: {
+                        signatureId: '(a: number, b: number) => number',
+                        symbolId: 'add',
+                    },
+                    symbol: {
+                        name: 'add',
+                        kind: 'function',
+                    },
+                    relatedSymbols: [],
+                    code: {
+                        //         declarationSnippet: `
+                        // export const add = (
+                        //   a: number,
+                        //   b: number,
+                        // ): number
+                        // `,
+                        snippet: 'return a + b',
+                    },
+                    existingJsDoc: {
+                        summary: 'Adds two numbers.',
+                        params: [
+                            {
+                                name: 'a',
+                                type: 'number',
+                                description: 'The first number.',
+                                sortOrder: 1,
+                            },
+                            {
+                                name: 'b',
+                                type: 'number',
+                                description: 'The second number.',
+                                sortOrder: 2,
+                            },
+                        ],
+                        returns: 'The sum of the two numbers.',
+                        tags: [],
+                    },
+                    effectSignals: undefined,
+                },
+            ],
+        };
+        const plan = await runQAWithEnvOrThrow(executeJsDocUpdatePlan(context), layer);
+        console.dir(plan, { depth: null });
+        expect(plan[0]?.summary.action.type).toBe('preserve');
+        expect(plan[0]?.params.every((p) => p.action.type === 'preserve')).toBe(true);
+        expect(plan[0]?.returns.action.type).toBe('preserve');
+    }, 60_000);
+});
+//# sourceMappingURL=simple-function.test.js.map

package/dist/pipelines/jsdoc-update/__sit__/simple-function.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-function.test.js","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/__sit__/simple-function.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAA;AAC9E,OAAO,eAAe,CAAA;AAGtB,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAA;AAE9E,MAAM,KAAK,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAA;AAChG,MAAM,mBAAmB,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAA;AAEhE,gBAAgB,CAAC,oCAAoC,EAAE,GAAG,EAAE;IAC1D,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,OAAO,GAAqB;YAChC,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,EAAE,YAAY,EAAE,qBAAqB,EAAE;YAC/C,iBAAiB;YACjB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE;wBACN,WAAW,EAAE,kCAAkC;wBAC/C,QAAQ,EAAE,KAAK;qBAChB;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,KAAK;wBACX,IAAI,EAAE,UAAU;qBACjB;oBACD,cAAc,EAAE,EAAE;oBAClB,IAAI,EAAE;wBACJ,gCAAgC;wBAChC,uBAAuB;wBACvB,eAAe;wBACf,eAAe;wBACf,YAAY;wBACZ,KAAK;wBACL,OAAO,EAAE,cAAc;qBACxB;oBAED,aAAa,EAAE;wBACb,MAAM,EAAE,EAAE;wBACV,IAAI,EAAE,EAAE;qBACT;oBACD,aAAa,EAAE,SAAS;iBACzB;aACF;SACF,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAElC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAA;QAEtC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAEtC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE9D,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE9D,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;IACrC,CAAC,EAAE,MAAM,CAAC,CAAA;IACV,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,OAAO,GAAqB;YAChC,OAAO,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,MAAM,EAAE,EAAE,YAAY,EAAE,wBAAwB,EAAE;YAElD,iBAAiB;YACjB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE;wBACN,WAAW,EAAE,kCAAkC;wBAC/C,QAAQ,EAAE,KAAK;qBAChB;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,KAAK;wBACX,IAAI,EAAE,UAAU;qBACjB;oBACD,cAAc,EAAE,EAAE;oBAClB,IAAI,EAAE;wBACJ,gCAAgC;wBAChC,uBAAuB;wBACvB,eAAe;wBACf,eAAe;wBACf,YAAY;wBACZ,KAAK;wBACL,OAAO,EAAE,cAAc;qBACxB;oBAED,aAAa,EAAE;wBACb,OAAO,EAAE,mBAAmB;wBAE5B,MAAM,EAAE;4BACN;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,mBAAmB;gCAChC,SAAS,EAAE,CAAC;6BACb;4BACD;gCACE,IAAI,EAAE,GAAG;gCACT,IAAI,EAAE,QAAQ;gCACd,WAAW,EAAE,oBAAoB;gCACjC,SAAS,EAAE,CAAC;6BACb;yBACF;wBAED,OAAO,EAAE,6BAA6B;wBAEtC,IAAI,EAAE,EAAE;qBACT;oBACD,aAAa,EAAE,SAAS;iBACzB;aACF;SACF,CAAA;QAED,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;QAE9E,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAElC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAErD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE7E,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACvD,CAAC,EAAE,MAAM,CAAC,CAAA;AACZ,CAAC,CAAC,CAAA"}

package/dist/pipelines/jsdoc-update/context/JsDocUpdateContext.d.ts

@@ -0,0 +1,156 @@
+import type { SymbolIdentity } from '@gyomu/schema/schemas/typescript/index';
+import type { EffectSignals } from '@gyomu/schema/typescript';
+/**
+ * Defines the base interface for a JSDoc update context containing project metadata and target identification.
+ */
+export interface TsDocSymbolContext {
+    /**
+     * The specific symbol identity targeted for the JSDoc update.
+     */
+    target: SymbolIdentity;
+    /**
+     * The metadata of the targeted symbol.
+     */
+    symbol: {
+        name: string;
+        kind: string;
+    };
+    /**
+     * Container for the code snippet information.
+     */
+    code: {
+        snippet?: string;
+    };
+    /**
+     * Optional existing JSDoc documentation for the target symbol.
+     */
+    existingJsDoc?: ExistingJsDoc;
+    /**
+     * The optional effect type declaration
+     */
+    effectSignals: Pick<EffectSignals, 'success' | 'error' | 'requirements'> | undefined;
+    /**
+     * List of related symbols to be documented.
+     */
+    relatedSymbols: Array<RelatedSymbol>;
+    /**
+     * List of documentable child members.
+     */
+    children?: Array<ContextEntry>;
+    /**
+     * Deep analysis metadata for code refinement.
+     */
+    analysis?: {
+        paramSemantics: Array<{
+            name: string;
+            meaning: string;
+            role: string;
+        }>;
+        protectedRegions: Array<ProtectedSection>;
+        returnSemantics?: string;
+        sideEffects: Array<string>;
+        schemaStructure?: SchemaStructureNode;
+    };
+    /**
+     * Configuration and metrics regarding how the symbol is used.
+     */
+    usageContext?: {
+        publicApi: boolean;
+        usedAcrossModules: boolean;
+        callSites?: number;
+    };
+}
+/**
+ * Represents an entry in the JSDoc update context, defining a target symbol and its associated metadata.
+ */
+export interface ContextEntry {
+    /**
+     * The target symbol identity to be documented.
+     */
+    target: SymbolIdentity;
+    /**
+     * The name of the symbol.
+     */
+    name: string;
+    /**
+     * The category of the symbol.
+     */
+    kind: 'property' | 'method' | 'parameter' | 'type';
+    /**
+     * The optional type definition of the symbol.
+     */
+    type?: string;
+    /**
+     * Existing JSDoc content associated with the symbol, if any.
+     */
+    existingJsDoc?: ExistingJsDoc;
+    /**
+     * The optional effect type declaration
+     */
+    effectSignals: Pick<EffectSignals, 'success' | 'error' | 'requirements'> | undefined;
+    /**
+     * Child entries nested under this symbol.
+     */
+    children?: Array<ContextEntry>;
+}
+/**
+ * Represents the existing JSDoc documentation structure for a symbol.
+ */
+export interface ExistingJsDoc {
+    /**
+     * The JSDoc summary text, if present.
+     */
+    summary?: string;
+    /**
+     * An array of parameter documentation entries.
+     */
+    params: Array<{
+        name: string;
+        sortOrder: number;
+        type?: string;
+        description?: string;
+    }>;
+    /**
+     * The return value documentation, if present.
+     */
+    returns?: string;
+    /**
+     * An array of additional JSDoc tags.
+     */
+    tags: Array<{
+        tag: string;
+        content: string;
+        sortOrder: number;
+    }>;
+}
+interface RelatedSymbol {
+    name: string;
+    kind: string;
+    signature: string;
+}
+export interface SchemaStructureNode {
+    name: string;
+    kind: 'property' | 'object' | 'array' | 'union' | 'primitive' | 'reference' | 'literal';
+    type?: string;
+    semanticHint?: string;
+    children?: Array<SchemaStructureNode>;
+}
+/**
+ * Represents a section of code or documentation that should be protected from automatic modification.
+ */
+export interface ProtectedSection {
+    /**
+     * The type of section being protected.
+     */
+    kind: 'summary' | 'param' | 'returns' | 'tag';
+    /**
+     * Optional identifier for the section.
+     */
+    key?: string;
+    /**
+     * The reason why the section is protected.
+     */
+    reason: 'preserve-marker' | 'human-edited' | 'custom-content';
+}
+export {};
+//# sourceMappingURL=JsDocUpdateContext.d.ts.map

package/dist/pipelines/jsdoc-update/context/JsDocUpdateContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsDocUpdateContext.d.ts","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/context/JsDocUpdateContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAA;AAC5E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE7D;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IAED;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAE7B;;OAEG;IACH,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,OAAO,GAAG,cAAc,CAAC,GAAG,SAAS,CAAA;IAEpF;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC,CAAA;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT,cAAc,EAAE,KAAK,CAAC;YACpB,IAAI,EAAE,MAAM,CAAA;YACZ,OAAO,EAAE,MAAM,CAAA;YACf,IAAI,EAAE,MAAM,CAAA;SACb,CAAC,CAAA;QAEF,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;QAEzC,eAAe,CAAC,EAAE,MAAM,CAAA;QAExB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAE1B,eAAe,CAAC,EAAE,mBAAmB,CAAA;KACtC,CAAA;IAED;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,SAAS,EAAE,OAAO,CAAA;QAClB,iBAAiB,EAAE,OAAO,CAAA;QAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,CAAA;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAE7B;;OAEG;IACH,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,OAAO,GAAG,cAAc,CAAC,GAAG,SAAS,CAAA;IAEpF;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAC,CAAA;IAEF;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;QACV,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,EAAE,MAAM,CAAA;QACf,SAAS,EAAE,MAAM,CAAA;KAClB,CAAC,CAAA;CACH;AAED,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IAEZ,IAAI,EAAE,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAA;IAEvF,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,QAAQ,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,KAAK,CAAA;IAE7C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,iBAAiB,GAAG,cAAc,GAAG,gBAAgB,CAAA;CAC9D"}

package/dist/pipelines/jsdoc-update/context/JsDocUpdateContext.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=JsDocUpdateContext.js.map

package/dist/pipelines/jsdoc-update/context/JsDocUpdateContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsDocUpdateContext.js","sourceRoot":"","sources":["../../../../src/pipelines/jsdoc-update/context/JsDocUpdateContext.ts"],"names":[],"mappings":""}