@rxap/plugin-gpt 20.0.1-dev.8 → 20.1.0-dev.1

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [20.1.0-dev.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.1.0-dev.0...@rxap/plugin-gpt@20.1.0-dev.1) (2025-02-10)
+
+**Note:** Version bump only for package @rxap/plugin-gpt
+
+# [20.1.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.0.1-dev.8...@rxap/plugin-gpt@20.1.0-dev.0) (2025-02-07)
+
+### Features
+
+- support new ai models ([a43ffc6](https://gitlab.com/rxap/packages/commit/a43ffc6b77b949c6521f0a6a4d7557734d062e42))
+
 ## [20.0.1-dev.8](https://gitlab.com/rxap/packages/compare/@rxap/plugin-gpt@20.0.1-dev.7...@rxap/plugin-gpt@20.0.1-dev.8) (2025-01-30)
 
 **Note:** Version bump only for package @rxap/plugin-gpt

package/package.json

@@ -1,12 +1,12 @@
 {
-  "version": "20.0.1-dev.8",
+  "version": "20.1.0-dev.1",
   "name": "@rxap/plugin-gpt",
   "license": "GPL-3.0-or-later",
   "dependencies": {
-    "@nx/devkit": "20.4.0",
-    "@rxap/ts-morph": "^1.5.3-dev.3",
-    "@rxap/workspace-ts-morph": "^19.1.9-dev.8",
-    "@rxap/workspace-utilities": "^19.6.1-dev.7",
+    "@nx/devkit": "20.4.2",
+    "@rxap/ts-morph": "^1.5.3-dev.5",
+    "@rxap/workspace-ts-morph": "^19.1.9-dev.10",
+    "@rxap/workspace-utilities": "^19.6.1-dev.9",
     "gpt-3-encoder": "^1.1.4",
     "openai": "^4.52.0",
     "ts-morph": "18.0.0",
@@ -43,7 +43,7 @@
   },
   "schematics": "./generators.json",
   "type": "commonjs",
-  "gitHead": "46346e73f18714b44ad1c9dafb311abdab1c33f1",
+  "gitHead": "3c5aef907af80a815e7c9a404878c2eda2596cf4",
   "types": "./src/index.d.ts",
   "main": "./src/index.js"
 }

package/src/generators/documentation/compose-context.d.ts

@@ -0,0 +1,2 @@
+import { SourceFile } from 'ts-morph';
+export declare function composeContext(sourceFile: SourceFile): string;

package/src/generators/documentation/compose-context.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.composeContext = composeContext;
+const xml2js_1 = require("xml2js");
+function sourceFileToContextSourceFile(sourceFile) {
+    return {
+        $: {
+            path: sourceFile.getFilePath(),
+        },
+        _: '\n' + sourceFile.getText({ trimLeadingIndentation: true, includeJsDocComments: false })
+    };
+}
+function getReferenced(sourceFile) {
+    return [
+        ...sourceFile.getReferencedSourceFiles(),
+        ...sourceFile.getReferencedSourceFiles().map(sf => getReferenced(sf)).flat()
+    ];
+}
+function composeContext(sourceFile) {
+    const builder = new xml2js_1.Builder();
+    const context = {
+        referenced: { sourceFile: [] },
+        used: { sourceFile: [] },
+    };
+    sourceFile.getReferencingSourceFiles().forEach(sf => {
+        context.used.sourceFile.push(sourceFileToContextSourceFile(sf));
+    });
+    getReferenced(sourceFile).forEach(sf => {
+        context.referenced.sourceFile.push(sourceFileToContextSourceFile(sf));
+    });
+    return builder.buildObject(context).replace(/root>/g, 'context>') + '\n';
+}
+//# sourceMappingURL=compose-context.js.map

package/src/generators/documentation/compose-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compose-context.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/compose-context.ts"],"names":[],"mappings":";;AAmCA,wCAmBC;AArDD,mCAAiC;AAkBjC,SAAS,6BAA6B,CAAC,UAAsB;IAC3D,OAAO;QACL,CAAC,EAAE;YACD,IAAI,EAAE,UAAU,CAAC,WAAW,EAAE;SAC/B;QACD,CAAC,EAAE,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE,sBAAsB,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;KAC5F,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,UAAsB;IAC3C,OAAO;QACL,GAAG,UAAU,CAAC,wBAAwB,EAAE;QACxC,GAAG,UAAU,CAAC,wBAAwB,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE;KAC7E,CAAC;AACJ,CAAC;AAED,SAAgB,cAAc,CAAC,UAAsB;IAEnD,MAAM,OAAO,GAAG,IAAI,gBAAO,EAAE,CAAC;IAE9B,MAAM,OAAO,GAAY;QACvB,UAAU,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;QAC9B,IAAI,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;KACzB,CAAC;IAEF,UAAU,CAAC,yBAAyB,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;QAClD,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,6BAA6B,CAAC,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;QACrC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,6BAA6B,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC;AAE3E,CAAC"}

package/src/generators/documentation/generator.js

@@ -2,10 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.documentationGenerator = documentationGenerator;
 const tslib_1 = require("tslib");
-const devkit_1 = require("@nx/devkit");
+const workspace_ts_morph_1 = require("@rxap/workspace-ts-morph");
+const fs_1 = require("fs");
+const path_1 = require("path");
 const process = require("process");
+const add_js_doc_1 = require("./add-js-doc");
+const compose_context_1 = require("./compose-context");
 const open_ai_instance_1 = require("./open-ai-instance");
-const process_project_1 = require("./process-project");
+const prompt_1 = require("./prompt");
 function skipProject(project, projectName, options) {
     var _a;
     if (options.project === projectName) {
@@ -18,30 +22,42 @@ function skipProject(project, projectName, options) {
 }
 function documentationGenerator(tree, options) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const openaiApiKey = (_a = options.openaiApiKey) !== null && _a !== void 0 ? _a : process.env.OPENAI_API_KEY;
-        const openaiOrganization = (_b = options.openaiOrgId) !== null && _b !== void 0 ? _b : process.env.OPENAI_ORG_ID;
-        const openaiProjectId = (_c = options.openaiProjectId) !== null && _c !== void 0 ? _c : process.env.OPENAI_PROJECT_ID;
+        const openaiOrganization = (_c = (_b = options.openaiOrgId) !== null && _b !== void 0 ? _b : process.env.OPENAI_ORG_ID) !== null && _c !== void 0 ? _c : process.env.OPENAI_ORGANIZATION;
+        const openaiProjectId = (_d = options.openaiProjectId) !== null && _d !== void 0 ? _d : process.env.OPENAI_PROJECT_ID;
         if (!openaiApiKey) {
             throw new Error('Can not find OPENAI_API_KEY environment variable');
         }
-        if (!openaiOrganization) {
-            throw new Error('Can not find OPENAI_ORGANIZATION environment variable');
-        }
-        if (!openaiProjectId) {
-            throw new Error('Can not find OPENAI_PROJECT_ID environment variable');
-        }
         yield (0, open_ai_instance_1.createOpenApi)({
             apiKey: openaiApiKey,
             organization: openaiOrganization,
             project: openaiProjectId,
         });
-        for (const [projectName, project] of (0, devkit_1.getProjects)(tree).entries()) {
-            if (skipProject(project, projectName, options)) {
-                continue;
+        // relative path form the workspace root
+        const path = (0, path_1.relative)(tree.root, process.cwd());
+        const systemPrompt = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, 'system-prompts', 'generic.txt'), 'utf-8');
+        yield (0, workspace_ts_morph_1.TsMorphTransform)(tree, path, (project) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            for (const sourceFile of project.getSourceFiles()) {
+                const context = (0, compose_context_1.composeContext)(sourceFile);
+                let target = `<sourceFile path="${sourceFile.getFilePath()}">\n`;
+                target += sourceFile.getText({ trimLeadingIndentation: true, includeJsDocComments: false });
+                target += '</sourceFile>\n';
+                for (const functionDeclaration of sourceFile.getFunctions()) {
+                    const question = `TASK: create the JsDoc documentation for the function \`${functionDeclaration.getName()}\` from the file \`${sourceFile.getFilePath()}\``;
+                    console.log(question);
+                    try {
+                        const jsDoc = yield (0, prompt_1.prompt)(options, systemPrompt, [context, target, question].join('\n\n'));
+                        console.log('jsDoc', jsDoc);
+                        (0, add_js_doc_1.addJsDoc)(options, functionDeclaration, jsDoc);
+                    }
+                    catch (e) {
+                        console.log(`jsDoc prompt error: ${e.message}`.red);
+                    }
+                    return;
+                }
             }
-            yield (0, process_project_1.processProject)(options, projectName, tree);
-        }
+        }));
     });
 }
 exports.default = documentationGenerator;

package/src/generators/documentation/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/generator.ts"],"names":[],"mappings":";;AAwBA,wDAqCC;;AA7DD,uCAIoB;AACpB,mCAAmC;AACnC,yDAAmD;AACnD,uDAAmD;AAGnD,SAAS,WAAW,CAAC,OAA6B,EAAE,WAAmB,EAAE,OAAqC;;IAE5G,IAAI,OAAO,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,MAAA,OAAO,CAAC,QAAQ,0CAAE,MAAM,EAAE,CAAC;QAC7B,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,KAAK,CAAC;AAEf,CAAC;AAED,SAAsB,sBAAsB,CAC1C,IAAU,EACV,OAAqC;;;QAGrC,MAAM,YAAY,GAAG,MAAA,OAAO,CAAC,YAAY,mCAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;QACxE,MAAM,kBAAkB,GAAG,MAAA,OAAO,CAAC,WAAW,mCAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;QAC5E,MAAM,eAAe,GAAG,MAAA,OAAO,CAAC,eAAe,mCAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAEjF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,IAAA,gCAAa,EAAC;YAClB,MAAM,EAAE,YAAY;YACpB,YAAY,EAAE,kBAAkB;YAChC,OAAO,EAAE,eAAe;SACzB,CAAC,CAAC;QAEH,KAAK,MAAM,CAAE,WAAW,EAAE,OAAO,CAAE,IAAI,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YAEnE,IAAI,WAAW,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC/C,SAAS;YACX,CAAC;YAED,MAAM,IAAA,gCAAc,EAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;QAEnD,CAAC;IAEH,CAAC;CAAA;AAED,kBAAe,sBAAsB,CAAC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/generator.ts"],"names":[],"mappings":";;AAiCA,wDAqDC;;AAjFD,iEAA4D;AAC5D,2BAAkC;AAClC,+BAGc;AACd,mCAAmC;AACnC,6CAAwC;AACxC,uDAAmD;AACnD,yDAAmD;AAEnD,qCAAkC;AAGlC,SAAS,WAAW,CAAC,OAA6B,EAAE,WAAmB,EAAE,OAAqC;;IAE5G,IAAI,OAAO,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,MAAA,OAAO,CAAC,QAAQ,0CAAE,MAAM,EAAE,CAAC;QAC7B,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,KAAK,CAAC;AAEf,CAAC;AAED,SAAsB,sBAAsB,CAC1C,IAAU,EACV,OAAqC;;;QAGrC,MAAM,YAAY,GAAG,MAAA,OAAO,CAAC,YAAY,mCAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;QACxE,MAAM,kBAAkB,GAAG,MAAA,MAAA,OAAO,CAAC,WAAW,mCAAI,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QAC/G,MAAM,eAAe,GAAG,MAAA,OAAO,CAAC,eAAe,mCAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAEjF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,IAAA,gCAAa,EAAC;YAClB,MAAM,EAAE,YAAY;YACpB,YAAY,EAAE,kBAAkB;YAChC,OAAO,EAAE,eAAe;SACzB,CAAC,CAAC;QAEH,wCAAwC;QACxC,MAAM,IAAI,GAAG,IAAA,eAAQ,EAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAEhD,MAAM,YAAY,GAAG,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC;QAE7F,MAAM,IAAA,qCAAgB,EAAC,IAAI,EAAE,IAAI,EAAE,CAAO,OAAO,EAAE,EAAE;YACnD,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;gBAElD,MAAM,OAAO,GAAG,IAAA,gCAAc,EAAC,UAAU,CAAC,CAAC;gBAE3C,IAAI,MAAM,GAAG,qBAAsB,UAAU,CAAC,WAAW,EAAG,MAAM,CAAC;gBACnE,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,sBAAsB,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC5F,MAAM,IAAI,iBAAiB,CAAC;gBAE5B,KAAK,MAAM,mBAAmB,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC;oBAC5D,MAAM,QAAQ,GAAG,2DAA2D,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC;oBAE5J,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACtB,IAAI,CAAC;wBACH,MAAM,KAAK,GAAG,MAAM,IAAA,eAAM,EAAC,OAAO,EAAE,YAAY,EAAE,CAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;wBAE9F,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;wBAE5B,IAAA,qBAAQ,EAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,CAAC,CAAC;oBAEhD,CAAC;oBAAC,OAAO,CAAM,EAAE,CAAC;wBAChB,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;oBACtD,CAAC;oBAED,OAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC,CAAA,CAAC,CAAC;IAEL,CAAC;CAAA;AAED,kBAAe,sBAAsB,CAAC"}

package/src/generators/documentation/process-source-file.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.processSourceFile = processSourceFile;
 const tslib_1 = require("tslib");
-const process_class_1 = require("./process-class");
 const process_function_1 = require("./process-function");
 function processSourceFile(options, sourceFile) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -10,9 +9,9 @@ function processSourceFile(options, sourceFile) {
         for (const functionDeclaration of sourceFile.getFunctions()) {
             yield (0, process_function_1.processFunction)(options, functionDeclaration);
         }
-        for (const classDeclaration of sourceFile.getClasses()) {
-            yield (0, process_class_1.processClass)(options, classDeclaration);
-        }
+        // for (const classDeclaration of sourceFile.getClasses()) {
+        //   await processClass(options, classDeclaration);
+        // }
     });
 }
 //# sourceMappingURL=process-source-file.js.map

package/src/generators/documentation/process-source-file.js.map

@@ -1 +1 @@
-{"version":3,"file":"process-source-file.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/process-source-file.ts"],"names":[],"mappings":";;AAQA,8CAgBC;;AApBD,mDAA+C;AAC/C,yDAAqD;AAGrD,SAAsB,iBAAiB,CACrC,OAAqC,EACrC,UAAsB;;QAGtB,OAAO,CAAC,GAAG,CAAC,uCAAwC,UAAU,CAAC,WAAW,EAAG,SAAS,CAAC,CAAC;QAExF,KAAK,MAAM,mBAAmB,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC;YAC5D,MAAM,IAAA,kCAAe,EAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACtD,CAAC;QAED,KAAK,MAAM,gBAAgB,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC;YACvD,MAAM,IAAA,4BAAY,EAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAChD,CAAC;IAGH,CAAC;CAAA"}
+{"version":3,"file":"process-source-file.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/process-source-file.ts"],"names":[],"mappings":";;AAQA,8CAgBC;;AAnBD,yDAAqD;AAGrD,SAAsB,iBAAiB,CACrC,OAAqC,EACrC,UAAsB;;QAGtB,OAAO,CAAC,GAAG,CAAC,uCAAwC,UAAU,CAAC,WAAW,EAAG,SAAS,CAAC,CAAC;QAExF,KAAK,MAAM,mBAAmB,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC;YAC5D,MAAM,IAAA,kCAAe,EAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACtD,CAAC;QAED,4DAA4D;QAC5D,mDAAmD;QACnD,IAAI;IAGN,CAAC;CAAA"}

package/src/generators/documentation/prompt.d.ts

@@ -1 +1,2 @@
-export declare function prompt(options: any, systemPrompt: string, prompt: string): Promise<string>;
+import { DocumentationGeneratorSchema } from './schema';
+export declare function prompt(options: DocumentationGeneratorSchema, systemPrompt: string, prompt: string): Promise<string>;

package/src/generators/documentation/prompt.js

@@ -7,9 +7,12 @@ const simple_prompt_1 = require("./simple-prompt");
 function prompt(options, systemPrompt, prompt) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         if (options.offline) {
+            console.log('Prompt:', prompt);
             return '';
         }
-        return (0, simple_prompt_1.SimplePrompt)(systemPrompt, prompt, (0, open_ai_instance_1.getOpenAi)());
+        else {
+            return (0, simple_prompt_1.SimplePrompt)(systemPrompt, prompt, (0, open_ai_instance_1.getOpenAi)());
+        }
     });
 }
 //# sourceMappingURL=prompt.js.map

package/src/generators/documentation/prompt.js.map

@@ -1 +1 @@
-{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/prompt.ts"],"names":[],"mappings":";;AAGA,wBAWC;;AAdD,yDAA+C;AAC/C,mDAA+C;AAE/C,SAAsB,MAAM,CAAC,OAAO,EAAE,YAAoB,EAAE,MAAc;;QAExE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,IAAA,4BAAY,EACjB,YAAY,EACZ,MAAM,EACN,IAAA,4BAAS,GAAE,CACZ,CAAC;IACJ,CAAC;CAAA"}
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/prompt.ts"],"names":[],"mappings":";;AAIA,wBAYC;;AAhBD,yDAA+C;AAE/C,mDAA+C;AAE/C,SAAsB,MAAM,CAAC,OAAqC,EAAE,YAAoB,EAAE,MAAc;;QAEtG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAC/B,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,OAAO,IAAA,4BAAY,EACjB,YAAY,EACZ,MAAM,EACN,IAAA,4BAAS,GAAE,CACZ,CAAC;QACJ,CAAC;IACH,CAAC;CAAA"}

package/src/generators/documentation/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/schema",
+  "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "Documentation",
   "title": "",
   "type": "object",

package/src/generators/documentation/simple-prompt.d.ts

@@ -1,10 +1,24 @@
 import { OpenAI } from 'openai';
 import { ChatCompletionCreateParamsBase } from 'openai/resources/chat/completions';
-export type Model = 'whisper-1' | 'dall-e-2' | 'gpt-3.5-turbo-16k' | 'tts-1-hd-1106' | 'tts-1-hd' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-0125-preview' | 'gpt-4-turbo-preview' | 'gpt-4-turbo' | 'gpt-3.5-turbo-instruct-0914' | 'gpt-4o' | 'gpt-3.5-turbo-instruct' | 'text-embedding-3-small' | 'tts-1' | 'gpt-4' | 'text-embedding-3-large' | 'gpt-4-1106-preview' | 'babbage-002' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'tts-1-1106' | 'dall-e-3' | 'text-embedding-ada-002' | 'davinci-002' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-4o-2024-05-13';
+import 'colors';
+/**
+ * Model Context size https://platform.openai.com/docs/models
+ */
+declare const tokenLimits: {
+    'gpt-4o': number;
+    'gpt-4o-mini': number;
+    o1: number;
+    'o1-mini': number;
+    'o3-mini': number;
+};
+export type Model = keyof typeof tokenLimits;
 export interface SimplePromptOptions {
     max_tokens?: number;
     model?: Model;
 }
 export declare function IsAllDefined(options: SimplePromptOptions): options is Required<SimplePromptOptions>;
 export declare function AssertAllDefined(options: SimplePromptOptions): asserts options is Required<SimplePromptOptions>;
-export declare function SimplePrompt(systemPrompt: string, prompt: string, openai: OpenAI, options?: Partial<ChatCompletionCreateParamsBase>): Promise<string>;
+export declare function SimplePrompt(systemPrompt: string, prompt: string, openai: OpenAI, options?: Partial<ChatCompletionCreateParamsBase> & {
+    model: Model;
+}): Promise<string>;
+export {};

package/src/generators/documentation/simple-prompt.js

@@ -4,13 +4,17 @@ exports.IsAllDefined = IsAllDefined;
 exports.AssertAllDefined = AssertAllDefined;
 exports.SimplePrompt = SimplePrompt;
 const tslib_1 = require("tslib");
-const gpt_3_encoder_1 = require("gpt-3-encoder");
+const tiktoken_1 = require("tiktoken");
+require("colors");
+/**
+ * Model Context size https://platform.openai.com/docs/models
+ */
 const tokenLimits = {
-    'gpt-4-4o': 128000,
-    'gpt-4-turbo': 128000,
-    'gpt-4': 8192,
-    'gpt-3.5-turbo': 4096,
-    'gpt-3.5-turbo-16k': 16384,
+    'gpt-4o': 128000, // $2.50
+    'gpt-4o-mini': 128000, // $0.15
+    'o1': 200000, // $15.00
+    'o1-mini': 128000, // $1.10
+    'o3-mini': 200000, // $1.10
 };
 function IsAllDefined(options) {
     return options.max_tokens !== undefined && options.model !== undefined;
@@ -22,15 +26,16 @@ function AssertAllDefined(options) {
 }
 function SimplePrompt(systemPrompt_1, prompt_1, openai_1) {
     return tslib_1.__awaiter(this, arguments, void 0, function* (systemPrompt, prompt, openai, options = {
-        max_tokens: 1024,
-        model: 'gpt-4-turbo',
+        model: 'o3-mini',
+        max_tokens: 10000
     }) {
-        var _a, _b, _c, _d;
-        const systemPromptLength = (0, gpt_3_encoder_1.encode)(systemPrompt).length;
-        const promptLength = (0, gpt_3_encoder_1.encode)(prompt).length;
-        const inputLength = Math.floor((systemPromptLength + promptLength) * 1.1);
-        (_a = options.model) !== null && _a !== void 0 ? _a : (options.model = 'gpt-4o');
-        (_b = options.max_tokens) !== null && _b !== void 0 ? _b : (options.max_tokens = 1024);
+        var _a, _b;
+        const enc = (0, tiktoken_1.encoding_for_model)(options.model);
+        const systemPromptLength = enc.encode(systemPrompt).length;
+        const promptLength = enc.encode(prompt).length;
+        enc.free();
+        const inputLength = systemPromptLength + promptLength;
+        (_a = options.model) !== null && _a !== void 0 ? _a : (options.model = 'o3-mini');
         if (!tokenLimits[options.model]) {
             throw new Error(`\x1b[31mModel '${options.model}' is not supported.\x1b[0m`);
         }
@@ -46,34 +51,34 @@ function SimplePrompt(systemPrompt_1, prompt_1, openai_1) {
                 options.max_tokens = tokenLimit - inputLength;
             }
         }
-        let content;
-        try {
-            const response = yield openai.chat.completions.create({
-                max_tokens: options.max_tokens,
-                model: options.model,
-                messages: [
-                    {
-                        'role': 'system',
-                        'content': systemPrompt,
-                    },
-                    {
-                        'role': 'user',
-                        'content': prompt,
-                    },
-                ],
-                temperature: 0,
-                top_p: 1,
-                frequency_penalty: 0,
-                presence_penalty: 0,
-            });
-            content = (_c = response.choices[0].message) === null || _c === void 0 ? void 0 : _c.content;
-        }
-        catch (e) {
-            console.log((_d = e.response) === null || _d === void 0 ? void 0 : _d.data);
-            throw new Error('OpenAI API error: ' + e.message);
+        let content = undefined;
+        console.log(`send with '${promptLength}' prompt tokens and '${systemPromptLength}' system prompt tokens with '${options.max_tokens}' max tokens`.grey);
+        const input = {
+            model: options.model,
+            messages: [
+                {
+                    'role': 'system',
+                    'content': systemPrompt,
+                },
+                {
+                    'role': 'user',
+                    'content': prompt,
+                },
+            ],
+        };
+        if (options.max_tokens) {
+            if (options.model.startsWith('o')) {
+                input.max_completion_tokens = options.max_tokens;
+            }
+            else {
+                input.max_tokens = options.max_tokens;
+            }
         }
+        const response = yield openai.chat.completions.create(input);
+        content = (_b = response.choices[0].message) === null || _b === void 0 ? void 0 : _b.content;
         if (!content) {
-            throw new Error(`\x1b[31mNo content in response for paper\x1b[0m`);
+            console.log('No content in response'.red);
+            throw new Error(`No content in response`);
         }
         return content;
     });

package/src/generators/documentation/simple-prompt.js.map

@@ -1 +1 @@
-{"version":3,"file":"simple-prompt.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/simple-prompt.ts"],"names":[],"mappings":";;AAmBA,oCAEC;AAED,4CAIC;AAED,oCAwEC;;AArGD,iDAAuC;AAIvC,MAAM,WAAW,GAAG;IAClB,UAAU,EAAE,MAAO;IACnB,aAAa,EAAE,MAAO;IACtB,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,KAAK;CAC3B,CAAC;AASF,SAAgB,YAAY,CAAC,OAA4B;IACvD,OAAO,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;AACzE,CAAC;AAED,SAAgB,gBAAgB,CAAC,OAA4B;IAC3D,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED,SAAsB,YAAY;iEAChC,YAAoB,EACpB,MAAc,EACd,MAAc,EACd,UAAmD;QACjD,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,aAAa;KACrB;;QAGD,MAAM,kBAAkB,GAAG,IAAA,sBAAM,EAAC,YAAY,CAAC,CAAC,MAAM,CAAC;QACvD,MAAM,YAAY,GAAG,IAAA,sBAAM,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAE3C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,kBAAkB,GAAG,YAAY,CAAC,GAAG,GAAG,CAAC,CAAC;QAE1E,MAAA,OAAO,CAAC,KAAK,oCAAb,OAAO,CAAC,KAAK,GAAK,QAAQ,EAAC;QAC3B,MAAA,OAAO,CAAC,UAAU,oCAAlB,OAAO,CAAC,UAAU,GAAK,IAAI,EAAC;QAE5B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,kBAAmB,OAAO,CAAC,KAAM,4BAA4B,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE9C,IAAI,WAAW,GAAG,UAAU,GAAG,GAAG,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,yBAA0B,WAAY,wCAAyC,UAAU;gBACzG,GAAI,SAAS,CAAC,CAAC;QACjB,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,GAAG,UAAU,GAAG,WAAW,EAAE,CAAC;gBAClD,OAAO,CAAC,GAAG,CAAC,gCAAiC,OAAO,CAAC,UAAW,wCAAyC,UAAU;oBACnH,WAAY,SAAS,CAAC,CAAC;gBACvB,OAAO,CAAC,UAAU,GAAG,UAAU,GAAG,WAAW,CAAC;YAChD,CAAC;QACH,CAAC;QAED,IAAI,OAA2B,CAAC;QAEhC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;gBACpD,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE;oBACR;wBACE,MAAM,EAAE,QAAQ;wBAChB,SAAS,EAAE,YAAY;qBACxB;oBACD;wBACE,MAAM,EAAE,MAAM;wBACd,SAAS,EAAE,MAAM;qBAClB;iBACF;gBACD,WAAW,EAAE,CAAC;gBACd,KAAK,EAAE,CAAC;gBACR,iBAAiB,EAAE,CAAC;gBACpB,gBAAgB,EAAE,CAAC;aACpB,CAAC,CAAC;YAEH,OAAO,GAAG,MAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,0CAAE,OAAO,CAAC;QAEjD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,GAAG,CAAC,MAAA,CAAC,CAAC,QAAQ,0CAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,OAAO,CAAC;IAEjB,CAAC;CAAA"}
+{"version":3,"file":"simple-prompt.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/gpt/src/generators/documentation/simple-prompt.ts"],"names":[],"mappings":";;AAwBA,oCAEC;AAED,4CAIC;AAED,oCA0EC;;AAzGD,uCAA8C;AAC9C,kBAAgB;AAEhB;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,EAAE,MAAO,EAAE,QAAQ;IAC3B,aAAa,EAAE,MAAO,EAAE,QAAQ;IAChC,IAAI,EAAE,MAAO,EAAE,SAAS;IACxB,SAAS,EAAE,MAAO,EAAE,QAAQ;IAC5B,SAAS,EAAE,MAAO,EAAE,QAAQ;CAC7B,CAAC;AASF,SAAgB,YAAY,CAAC,OAA4B;IACvD,OAAO,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;AACzE,CAAC;AAED,SAAgB,gBAAgB,CAAC,OAA4B;IAC3D,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED,SAAsB,YAAY;iEAChC,YAAoB,EACpB,MAAc,EACd,MAAc,EACd,UAAsE;QACpE,KAAK,EAAE,SAAS;QAChB,UAAU,EAAE,KAAM;KACnB;;QAGD,MAAM,GAAG,GAAG,IAAA,6BAAkB,EAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE9C,MAAM,kBAAkB,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC;QAC3D,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAE/C,GAAG,CAAC,IAAI,EAAE,CAAC;QAEX,MAAM,WAAW,GAAG,kBAAkB,GAAG,YAAY,CAAC;QAEtD,MAAA,OAAO,CAAC,KAAK,oCAAb,OAAO,CAAC,KAAK,GAAK,SAAS,EAAC;QAE5B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,kBAAmB,OAAO,CAAC,KAAM,4BAA4B,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE9C,IAAI,WAAW,GAAG,UAAU,GAAG,GAAG,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,yBAA0B,WAAY,wCAAyC,UAAU;gBACzG,GAAI,SAAS,CAAC,CAAC;QACjB,CAAC;QAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,GAAG,UAAU,GAAG,WAAW,EAAE,CAAC;gBAClD,OAAO,CAAC,GAAG,CAAC,gCAAiC,OAAO,CAAC,UAAW,wCAAyC,UAAU;oBACnH,WAAY,SAAS,CAAC,CAAC;gBACvB,OAAO,CAAC,UAAU,GAAG,UAAU,GAAG,WAAW,CAAC;YAChD,CAAC;QACH,CAAC;QAED,IAAI,OAAO,GAAuB,SAAS,CAAC;QAE5C,OAAO,CAAC,GAAG,CAAC,cAAc,YAAY,wBAAwB,kBAAkB,gCAAgC,OAAO,CAAC,UAAU,cAAc,CAAC,IAAI,CAAC,CAAC;QACvJ,MAAM,KAAK,GAA2C;YACpD,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,QAAQ,EAAE;gBACR;oBACE,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,YAAY;iBACxB;gBACD;oBACE,MAAM,EAAE,MAAM;oBACd,SAAS,EAAE,MAAM;iBAClB;aACF;SACF,CAAC;QACF,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,KAAK,CAAC,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC;YACnD,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;YACxC,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE7D,OAAO,GAAG,MAAA,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,0CAAE,OAAO,CAAC;QAE/C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,OAAO,CAAC;IAEjB,CAAC;CAAA"}

package/src/generators/documentation/system-prompts/block-tags.txt

@@ -0,0 +1,132 @@
+@abstract (synonyms: @virtual)
+This member must be implemented (or overridden) by the inheritor.
+@access
+Specify the access level of this member (private, package-private, public, or protected).
+@alias
+Treat a member as if it had a different name.
+@async
+Indicate that a function is asynchronous.
+@augments (synonyms: @extends)
+Indicate that a symbol inherits from, and adds to, a parent symbol.
+@author
+Identify the author of an item.
+@borrows
+This object uses something from another object.
+@class (synonyms: @constructor)
+This function is intended to be called with the "new" keyword.
+@classdesc
+Use the following text to describe the entire class.
+@constant (synonyms: @const)
+Document an object as a constant.
+@constructs
+This function member will be the constructor for the previous class.
+@copyright
+Document some copyright information.
+@default (synonyms: @defaultvalue)
+Document the default value.
+@deprecated
+Document that this is no longer the preferred way.
+@description (synonyms: @desc)
+Describe a symbol.
+@enum
+Document a collection of related properties.
+@event
+Document an event.
+@example
+Provide an example of how to use a documented item.
+@exports
+Identify the member that is exported by a JavaScript module.
+@external (synonyms: @host)
+Identifies an external class, namespace, or module.
+@file (synonyms: @fileoverview, @overview)
+Describe a file.
+@fires (synonyms: @emits)
+Describe the events this method may fire.
+@function (synonyms: @func, @method)
+Describe a function or method.
+@generator
+Indicate that a function is a generator function.
+@global
+Document a global object.
+@hideconstructor
+Indicate that the constructor should not be displayed.
+@ignore
+Omit a symbol from the documentation.
+@implements
+This symbol implements an interface.
+@inheritdoc
+Indicate that a symbol should inherit its parent's documentation.
+@inner
+Document an inner object.
+@instance
+Document an instance member.
+@interface
+This symbol is an interface that others can implement.
+@kind
+What kind of symbol is this?
+@lends
+Document properties on an object literal as if they belonged to a symbol with a given name.
+@license
+Identify the license that applies to this code.
+@listens
+List the events that a symbol listens for.
+@member (synonyms: @var)
+Document a member.
+@memberof
+This symbol belongs to a parent symbol.
+@mixes
+This object mixes in all the members from another object.
+@mixin
+Document a mixin object.
+@module
+Document a JavaScript module.
+@name
+Document the name of an object.
+@namespace
+Document a namespace object.
+@override
+Indicate that a symbol overrides its parent.
+@package
+This symbol is meant to be package-private.
+@param (synonyms: @arg, @argument)
+Document the parameter to a function.
+@private
+This symbol is meant to be private.
+@property (synonyms: @prop)
+Document a property of an object.
+@protected
+This symbol is meant to be protected.
+@public
+This symbol is meant to be public.
+@readonly
+This symbol is meant to be read-only.
+@requires
+This file requires a JavaScript module.
+@returns (synonyms: @return)
+Document the return value of a function.
+@see
+Refer to some other documentation for more information.
+@since
+When was this feature added?
+@static
+Document a static member.
+@summary
+A shorter version of the full description.
+@this
+What does the 'this' keyword refer to here?
+@throws (synonyms: @exception)
+Describe what errors could be thrown.
+@todo
+Document tasks to be completed.
+@tutorial
+Insert a link to an included tutorial file.
+@type
+Document the type of an object.
+@typedef
+Document a custom type.
+@variation
+Distinguish different objects with the same name.
+@version
+Documents the version number of an item.
+@yields (synonyms: @yield)
+Document the value yielded by a generator function.

package/src/generators/documentation/system-prompts/context.xsd

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            elementFormDefault="qualified">
+
+    <!-- Definition of the sourceFileType to capture the 'path' attribute -->
+    <xsd:complexType name="sourceFileType">
+        <xsd:attribute name="path" type="xsd:string" use="required"/>
+    </xsd:complexType>
+
+    <!-- Root element 'context' -->
+    <xsd:element name="context">
+        <xsd:complexType>
+            <xsd:sequence>
+                <!-- 'referenced' element with multiple 'source-file' elements -->
+                <xsd:element name="referenced" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="source-file" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+                        </xsd:sequence>
+                    </xsd:complexType>
+                </xsd:element>
+
+                <!-- 'used' element with multiple 'source-file' elements -->
+                <xsd:element name="used" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="source-file" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+                        </xsd:sequence>
+                    </xsd:complexType>
+                </xsd:element>
+            </xsd:sequence>
+        </xsd:complexType>
+    </xsd:element>
+
+</xsd:schema>

package/src/generators/documentation/system-prompts/generic.txt

@@ -0,0 +1,375 @@
+Your task is to generate complete JSDoc documentation for the provided TypeScript source code. The context supplied consists of two parts:
+
+1. The source code and all related files (both files referenced by the source code and files that use the source code) are provided as context formatted according to the schema in the context.xsd file below.
+
+2. An overview of the available JSDoc block tags is provided in the block-tags.txt file below. You must use these tags in your documentation.
+
+Use the following file contents as reference:
+
+-------------------- block-tags.txt --------------------
+@deprecated
+Document that this is no longer the preferred way.
+
+@description (synonyms: @desc)
+Describe a symbol.
+
+@enum
+Document a collection of related properties.
+
+@event
+Document an event.
+
+@example
+Provide an example of how to use a documented item.
+
+@exports
+Identify the member that is exported by a JavaScript module.
+
+@external (synonyms: @host)
+Identifies an external class, namespace, or module.
+
+@file (synonyms: @fileoverview, @overview)
+Describe a file.
+
+@fires (synonyms: @emits)
+Describe the events this method may fire.
+
+@function (synonyms: @func, @method)
+Describe a function or method.
+
+@generator
+Indicate that a function is a generator function.
+
+@global
+Document a global object.
+
+@hideconstructor
+Indicate that the constructor should not be displayed.
+
+@ignore
+Omit a symbol from the documentation.
+
+@implements
+This symbol implements an interface.
+
+@inheritdoc
+Indicate that a symbol should inherit its parent's documentation.
+
+@inner
+Document an inner object.
+
+@instance
+Document an instance member.
+
+@interface
+This symbol is an interface that others can implement.
+
+@kind
+What kind of symbol is this?
+
+@lends
+Document properties on an object literal as if they belonged to a symbol with a given name.
+
+@license
+Identify the license that applies to this code.
+
+@listens
+List the events that a symbol listens for.
+
+@member (synonyms: @var)
+Document a member.
+
+@memberof
+This symbol belongs to a parent symbol.
+
+@mixes
+This object mixes in all the members from another object.
+
+@mixin
+Document a mixin object.
+
+@module
+Document a JavaScript module.
+
+@name
+Document the name of an object.
+
+@namespace
+Document a namespace object.
+
+@override
+Indicate that a symbol overrides its parent.
+
+@package
+This symbol is meant to be package-private.
+
+@param (synonyms: @arg, @argument)
+Document the parameter to a function.
+
+@private
+This symbol is meant to be private.
+
+@property (synonyms: @prop)
+Document a property of an object.
+
+@protected
+This symbol is meant to be protected.
+
+@public
+This symbol is meant to be public.
+
+@readonly
+This symbol is meant to be read-only.
+
+@requires
+This file requires a JavaScript module.
+
+@returns (synonyms: @return)
+Document the return value of a function.
+
+@see
+Refer to some other documentation for more information.
+
+@since
+When was this feature added?
+
+@static
+Document a static member.
+
+@summary
+A shorter version of the full description.
+
+@this
+What does the 'this' keyword refer to here?
+
+@throws (synonyms: @exception)
+Describe what errors could be thrown.
+
+@todo
+Document tasks to be completed.
+
+@tutorial
+Insert a link to an included tutorial file.
+
+@type
+Document the type of an object.
+
+@typedef
+Document a custom type.
+
+@variation
+Distinguish different objects with the same name.
+
+@version
+Documents the version number of an item.
+
+@yields (synonyms: @yield)
+Document the value yielded by a generator function.
+------------------------------------------------------------
+
+-------------------- context.xsd --------------------
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            elementFormDefault="qualified">
+
+    <!-- Definition of the sourceFileType to capture the 'path' attribute -->
+    <xsd:complexType name="sourceFileType">
+        <xsd:attribute name="path" type="xsd:string" use="required"/>
+    </xsd:complexType>
+
+    <!-- Root element 'context' -->
+    <xsd:element name="context">
+        <xsd:complexType>
+            <xsd:sequence>
+                <!-- 'referenced' element with multiple 'source-file' elements -->
+                <xsd:element name="referenced" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="source-file" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+                        </xsd:sequence>
+                    </xsd:complexType>
+                </xsd:element>
+
+                <!-- 'used' element with multiple 'source-file' elements -->
+                <xsd:element name="used" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="source-file" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+                        </xsd:sequence>
+                    </xsd:complexType>
+                </xsd:element>
+
+            </xsd:sequence>
+        </xsd:complexType>
+    </xsd:element>
+
+</xsd:schema>
+------------------------------------------------------------
+
+Instructions:
+- Read the provided source code along with its related files (referenced and using) as structured by the context.xsd.
+- Create the complete JSDoc documentation using only the JSDoc block tags listed above.
+- Output ONLY the JSDoc content, without any additional text or any TypeScript comment syntax (omit /*, */, etc.).
+
+Example Input:
+------------------------------------------------------------
+<context>
+  <referenced>
+    <sourceFile path="/delete-undefined-properties.ts">
+export function DeleteUndefinedProperties<T extends {}>(obj: T, recursive?: boolean): Exclude<T, undefined> {
+  if (!obj || typeof obj !== 'object') {
+    return obj as any;
+  }
+
+  const keys = Object.keys(obj);
+  const cloneObj: any = {};
+
+  for (const key of keys) {
+    if ((obj as any)[key] !== undefined) {
+      const value = (obj as any)[key];
+      cloneObj[key] = value;
+      if (recursive && value) {
+        if (Array.isArray(value)) {
+          cloneObj[key] = value.map((item) => DeleteUndefinedProperties(item, true));
+        } else if (typeof value === 'object') {
+          cloneObj[key] = DeleteUndefinedProperties(value, true);
+        }
+      }
+    }
+  }
+
+  return cloneObj;
+}
+    </sourceFile>
+    <sourceFile path="/delete-null-properties.ts">
+export function DeleteNullProperties<T extends {}>(obj: T, recursive?: boolean): Exclude<T, null> {
+  if (!obj || typeof obj !== 'object') {
+    return obj as any;
+  }
+
+  const keys = Object.keys(obj);
+  const cloneObj: any = {};
+
+  for (const key of keys) {
+    if ((obj as any)[key] !== null) {
+      const value = (obj as any)[key];
+      cloneObj[key] = value;
+      if (recursive && value) {
+        if (Array.isArray(value)) {
+          cloneObj[key] = value.map((item) => DeleteNullProperties(item, true));
+        } else if (typeof value === 'object') {
+          cloneObj[key] = DeleteNullProperties(value, true);
+        }
+      }
+    }
+  }
+
+  return cloneObj;
+}
+    </sourceFile>
+  </referenced>
+  <used>
+    <sourceFile path="/delete-empty-properties.spec.ts">
+import { DeleteEmptyProperties } from './delete-empty-properties';
+
+describe('DeleteEmptyProperties function', () => {
+  test('should remove null properties from an object', () => {
+    const inputObj = {
+      a: 1,
+      b: null,
+      c: 'test',
+    };
+
+    const expectedOutput = {
+      a: 1,
+      c: 'test',
+    };
+
+    expect(DeleteEmptyProperties(inputObj)).toEqual(expectedOutput);
+  });
+
+  test('should not remove null properties from nested objects if recursive flag is not set', () => {
+    const inputObj = {
+      a: 1,
+      b: null,
+      c: {
+        d: 3,
+        e: null,
+      },
+    };
+
+    const expectedOutput = {
+      a: 1,
+      c: {
+        d: 3,
+        e: null,
+      },
+    };
+
+    expect(DeleteEmptyProperties(inputObj)).toEqual(expectedOutput);
+  });
+
+  test('should remove null properties from nested objects if recursive flag is set', () => {
+    const inputObj = {
+      a: 1,
+      b: null,
+      c: {
+        d: 3,
+        e: null,
+      },
+    };
+
+    const expectedOutput = {
+      a: 1,
+      c: {
+        d: 3,
+      },
+    };
+
+    expect(DeleteEmptyProperties(inputObj, true)).toEqual(expectedOutput);
+  });
+});
+    </sourceFile>
+  </used>
+</context>
+
+
+<sourceFile path="/delete-empty-properties.ts">
+import { DeleteUndefinedProperties } from './delete-undefined-properties';
+import { DeleteNullProperties } from './delete-null-properties';
+
+export function DeleteEmptyProperties<T extends {}>(obj: T, recursive?: boolean): Exclude<Exclude<T, null>, undefined> {
+  return DeleteUndefinedProperties(DeleteNullProperties(obj, recursive), recursive);
+}
+</sourceFile>
+
+TASK: create the JsDoc documentation for the function DeleteEmptyProperties from the file `delete-empty-properties.ts`
+------------------------------------------------------------
+
+Example Output:
+------------------------------------------------------------
+Deletes all properties from an object that are either null or undefined.
+
+@template T - The type of the object. It must be an object type.
+
+@param {T} obj - The object from which to delete the properties. This object is not modified.
+
+@param {boolean} [recursive=false] - Optional. If true, the function will recursively delete null and undefined properties from all nested objects and arrays within the object. If false or omitted, the function will only delete null and undefined properties from the top level of the object.
+
+@returns {Exclude<Exclude<T, null>, undefined>} - A new object of the same type as the input object, but with all null and undefined properties removed. If the recursive option is true, all nested objects and arrays within the object will also have their null and undefined properties removed.
+
+@example
+```typescript
+// returns { a: 1, c: { d: 4 } }
+DeleteEmptyProperties({ a: 1, b: null, c: { d: 4, e: undefined } }, true);
+```
+
+@example
+```typescript
+// returns { a: 1, c: { d: 4, e: undefined } }
+DeleteEmptyProperties({ a: 1, b: null, c: { d: 4, e: undefined } });
+```
+------------------------------------------------------------
+Remember:
+- Your output must include only the JSDoc documentation content as shown in the example output, with no surrounding comment syntax.
+- Ensure if an example is given the code is inclosed in "```typescript" and "```"