@rxap/plugin-llm 20.0.0-dev.1

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

@@ -0,0 +1,242 @@
+Your task is to generate complete TSDoc 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 TSDoc 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 --------------------
+# @default
+
+The @default tag can be used to document the default value for an accessor or property.
+```typescript
+export interface CompilerOptions {
+    strict?: boolean;
+    /**
+     * @defaultValue `true` if `strict` is `true`, otherwise `false`
+     */
+    strictNullChecks?: boolean;
+}
+```
+
+# @example
+
+The example tag indicates that the following text is an example of how to use the function.
+
+```typescript
+/**
+ * Takes the factorial of `n`.
+ *
+ * @example
+ * // If there are no code blocks, TypeDoc assumes the whole tag
+ * // should be a code block. This is not valid TSDoc, but is recognized
+ * // by VSCode and enables better TSDoc support.
+ * factorial(1)
+ *
+ * @example
+ * If there is a code block, then both TypeDoc and VSCode will treat
+ * text outside of the code block as regular text.
+ * ```ts
+ * factorial(1)
+ * ```
+ */
+export function factorial(n: number): number;
+```
+
+# @returns
+
+The @returns tag can be used to document the return value of a function. At most one @returns tag should be present in a comment.
+
+```typescript
+/**
+ * @param a - the first number
+ * @param b - the second number
+ * @returns The sum of `a` and `b`
+ */
+export function sum(a: number, b: number): number;
+```
+
+# @summary
+
+The @summary tag should be used to give a short summary of the commented code. Is only sutable for functions, classes anc class methods
+
+```typescript
+/**
+ * @summary
+ * This description will be used on the **module** page
+ */
+export function forkProcess(): void;
+```
+
+# @typeParam
+
+The @typeParam tag is used to document a type parameter of a function, method, class, interface or type alias.
+The TSDoc standard requires that the @typeParam tag not include types and that the parameter name must be followed by a hyphen to separate it from the description.
+
+```typescript
+/**
+ * @typeParam T - the identity type
+ */
+export function identity<T>(x: T): T {
+    return x;
+}
+```
+
+# @throws
+
+The @throws tag can be used to document an exception that can be thrown by a function or method.
+
+```typescript
+/**
+ * @throws {@link UserError} if `max < min`
+ */
+export function rand(min: number, max: number): number;
+```
+
+# @property
+
+The @property tag can be used to add a comment to a child of the current reflection. It is intended for use with the @namespace and @interface tags which might not have convenient places to include comments for each member.
+
+```typescript
+/**
+ * This will be displayed as an interface
+ * @property a comment for a
+ * @property b comment for b
+ * @interface
+ */
+export type Resolved = Record<"a" | "b" | "c", string>;
+
+// will be documented as if you wrote
+
+/** This will be displayed as an interface */
+export interface Resolved {
+    /** comment for a */
+    a: string;
+    /** comment for b */
+    b: string;
+    c: string;
+}
+```
+
+# @param
+
+The @param tag is used to document a parameter of a function or method.
+
+The TSDoc standard requires that the @param tag not include types and that the parameter name must be followed by a hyphen to separate it from the description.
+
+```typescript
+/**
+ * @param a - the first number
+ * @param b - the second number
+ */
+export function sum(a: number, b: number) {
+    return a + b;
+}
+```
+
+## Object Literals
+
+If the type of a parameter is an object literal type, a union containing an object literal type, or an intersection containing an object literal type, property names may be separated by `.` to add a comment to a single level of a nested property.
+
+```typescript
+/**
+ * @param options - documentation for the whole parameter
+ * @param options.value - documentation for the `value` property
+ * @param options.nested.value - NOT supported
+ */
+export function configure(
+    options: { value: string; nested: { value: string } } | undefined,
+) {}
+```
+
+## Destructured Parameters
+
+If your function uses destructured parameters, TypeDoc will attempt to infer the parameter name from your usage of the @param tag. For it to be successful, all parameters must be documented. If TypeDoc fails to infer the name of the destructured parameter, it will be documented as __namedParameters.
+
+```typescript
+/**
+ * @param options - docs
+ */
+export function configure({ value }: { value: string }) {}
+
+// will be documented as if written as
+export function configure(options: { value: string }) {}
+```
+
+
+------------------------------------------------------------
+
+-------------------- 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 'sourceFile' elements -->
+                <xsd:element name="referenced" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="sourceFile" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+                        </xsd:sequence>
+                    </xsd:complexType>
+                </xsd:element>
+
+                <!-- 'used' element with multiple 'sourceFile' elements -->
+                <xsd:element name="used" minOccurs="0" maxOccurs="1">
+                    <xsd:complexType>
+                        <xsd:sequence>
+                            <xsd:element name="sourceFile" 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 TSDoc documentation using only the TSDoc block tags listed above.
+- Output ONLY the TSDoc content, without any additional text or any TypeScript comment syntax (omit /*, */, etc.).
+
+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 obj - The object from which to delete the properties. This object is not modified.
+
+@param recursive - 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 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 TSDoc documentation content as shown in the example output, with no surrounding comment syntax.
+- Ensure if a code example is given the code is inclosed in "```typescript" and "```"
+- ONLY OUTPUT THE COMMENT TEXT WITHOUT ANY OTHER RESPONSE LIKE "Based on the source code" etc.

package/src/generators/init/generator.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import { InitGeneratorSchema } from './schema';
+export declare function initGenerator(tree: Tree, options: InitGeneratorSchema): Promise<void>;
+export default initGenerator;

package/src/generators/init/generator.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initGenerator = initGenerator;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const path_1 = require("path");
+function initGenerator(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c, _d, _e;
+        const packageJsonFilePath = (0, path_1.relative)(tree.root, (0, path_1.join)(__dirname, '..', '..', '..', 'package.json'));
+        if (!tree.exists(packageJsonFilePath)) {
+            console.error('package.json not found in: ' + packageJsonFilePath);
+            return;
+        }
+        const { peerDependencies, name: packageName } = JSON.parse(tree.read(packageJsonFilePath, 'utf-8'));
+        console.log(`Coerce peer dependencies for package: ${packageName}`);
+        if (!peerDependencies || !Object.keys(peerDependencies).length) {
+            console.log('No peer dependencies found');
+            return;
+        }
+        console.log(`Peer dependencies: ${Object.keys(peerDependencies).join(', ')}`);
+        const rootPackageJson = JSON.parse(tree.read('package.json', 'utf-8'));
+        let isDevDependency = !!((_a = rootPackageJson.devDependencies) === null || _a === void 0 ? void 0 : _a[packageName]);
+        if (isDevDependency &&
+            [/^@rxap\/ngx/, /^@rxap\/nest/].some((rx) => rx.test(packageName))) {
+            (_b = rootPackageJson.dependencies) !== null && _b !== void 0 ? _b : (rootPackageJson.dependencies = {});
+            rootPackageJson.dependencies[packageName] =
+                rootPackageJson.devDependencies[packageName];
+            delete rootPackageJson.devDependencies[packageName];
+            isDevDependency = false;
+            tree.write('package.json', JSON.stringify(rootPackageJson, null, 2));
+        }
+        if (!isDevDependency && [
+            /^@rxap\/plugin/,
+            /^@rxap\/workspace/,
+            /@rxap\/schematic/,
+        ]) {
+            (_c = rootPackageJson.devDependencies) !== null && _c !== void 0 ? _c : (rootPackageJson.devDependencies = {});
+            rootPackageJson.devDependencies[packageName] =
+                rootPackageJson.dependencies[packageName];
+            delete rootPackageJson.dependencies[packageName];
+            isDevDependency = true;
+            tree.write('package.json', JSON.stringify(rootPackageJson, null, 2));
+        }
+        const missingPeerDependencies = Object.entries(peerDependencies)
+            .filter(([dep]) => {
+            var _a, _b;
+            return !((_a = rootPackageJson.dependencies) === null || _a === void 0 ? void 0 : _a[dep]) &&
+                !((_b = rootPackageJson.devDependencies) === null || _b === void 0 ? void 0 : _b[dep]);
+        })
+            .reduce((acc, [dep, version]) => (Object.assign(Object.assign({}, acc), { [dep]: version })), {});
+        if (!Object.keys(missingPeerDependencies).length) {
+            console.log('No missing peer dependencies');
+            return;
+        }
+        if (isDevDependency) {
+            (0, devkit_1.addDependenciesToPackageJson)(tree, {}, missingPeerDependencies);
+        }
+        else {
+            (0, devkit_1.addDependenciesToPackageJson)(tree, missingPeerDependencies, {});
+        }
+        yield (0, devkit_1.formatFiles)(tree);
+        (0, devkit_1.installPackagesTask)(tree);
+        for (const peer of Object.keys(missingPeerDependencies)) {
+            console.log(`Peer dependency ${peer} added to package.json`);
+            const peerPackageJsonFilePath = (0, path_1.join)('node_modules', ...peer.split('/'), 'package.json');
+            if (!tree.exists(peerPackageJsonFilePath)) {
+                console.log(`Peer dependency ${peer} has no package.json`);
+                continue;
+            }
+            const { generators, schematics } = JSON.parse(tree.read(peerPackageJsonFilePath, 'utf-8'));
+            if (!generators && !schematics) {
+                console.log(`Peer dependency ${peer} has no generators or schematics`);
+                continue;
+            }
+            const configFile = generators || schematics;
+            if (!tree.exists((0, path_1.join)('node_modules', ...peer.split('/'), configFile))) {
+                console.log(`Peer dependency ${peer} has no generators or schematics file`);
+                continue;
+            }
+            const config = JSON.parse(tree.read((0, path_1.join)('node_modules', ...peer.split('/'), configFile), 'utf-8'));
+            if (!((_d = config.generators) === null || _d === void 0 ? void 0 : _d.init)) {
+                console.log(`Peer dependency ${peer} has no init generator`);
+                continue;
+            }
+            const initGeneratorFilePath = config.generators.init.factory;
+            const fullInitGeneratorFilePath = (0, path_1.join)('node_modules', ...peer.split('/'), initGeneratorFilePath) + '.js';
+            if (!tree.exists(fullInitGeneratorFilePath)) {
+                console.log(`Peer dependency ${peer} has no init generator file: ` +
+                    fullInitGeneratorFilePath);
+                continue;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const initGenerator = (_e = require((0, path_1.join)('node_modules', ...peer.split('/'), initGeneratorFilePath))) === null || _e === void 0 ? void 0 : _e.default;
+            if (typeof initGenerator !== 'function') {
+                console.log(`Peer dependency ${peer} has no init generator function`);
+                continue;
+            }
+            console.log(`Run init generator for peer dependency ${peer}`);
+            yield initGenerator(tree, options);
+        }
+    });
+}
+exports.default = initGenerator;
+//# sourceMappingURL=generator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/llm/src/generators/init/generator.ts"],"names":[],"mappings":";;AASA,sCAgIC;;AAzID,uCAKoB;AACpB,+BAAsC;AAGtC,SAAsB,aAAa,CAAC,IAAU,EAAE,OAA4B;;;QAC1E,MAAM,mBAAmB,GAAG,IAAA,eAAQ,EAClC,IAAI,CAAC,IAAI,EACT,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAClD,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACtC,OAAO,CAAC,KAAK,CAAC,6BAA6B,GAAG,mBAAmB,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QACD,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CACxD,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAE,CACzC,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,yCAAyC,WAAW,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,CAAC;YAC/D,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAC1C,OAAO;QACT,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,sBAAsB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAE9E,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAE,CAAC,CAAC;QAExE,IAAI,eAAe,GAAG,CAAC,CAAC,CAAA,MAAA,eAAe,CAAC,eAAe,0CAAG,WAAW,CAAC,CAAA,CAAC;QAEvE,IACE,eAAe;YACf,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,EAClE,CAAC;YACD,MAAA,eAAe,CAAC,YAAY,oCAA5B,eAAe,CAAC,YAAY,GAAK,EAAE,EAAC;YACpC,eAAe,CAAC,YAAY,CAAC,WAAW,CAAC;gBACvC,eAAe,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;YAC/C,OAAO,eAAe,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;YACpD,eAAe,GAAG,KAAK,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACvE,CAAC;QACD,IACE,CAAC,eAAe,IAAI;YAClB,gBAAgB;YAChB,mBAAmB;YACnB,kBAAkB;SACnB,EACD,CAAC;YACD,MAAA,eAAe,CAAC,eAAe,oCAA/B,eAAe,CAAC,eAAe,GAAK,EAAE,EAAC;YACvC,eAAe,CAAC,eAAe,CAAC,WAAW,CAAC;gBAC1C,eAAe,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAC5C,OAAO,eAAe,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YACjD,eAAe,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,uBAAuB,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC;aAC7D,MAAM,CACL,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE;;YACR,OAAA,CAAC,CAAA,MAAA,eAAe,CAAC,YAAY,0CAAG,GAAG,CAAC,CAAA;gBACpC,CAAC,CAAA,MAAA,eAAe,CAAC,eAAe,0CAAG,GAAG,CAAC,CAAA,CAAA;SAAA,CAC1C;aACA,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,OAAO,IAAG,EAAE,EAAE,CAAC,CAAC;QAErE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,MAAM,EAAE,CAAC;YACjD,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;YAC5C,OAAO;QACT,CAAC;QAED,IAAI,eAAe,EAAE,CAAC;YACpB,IAAA,qCAA4B,EAAC,IAAI,EAAE,EAAE,EAAE,uBAAuB,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,IAAA,qCAA4B,EAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;QAE1B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACxD,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,wBAAwB,CAAC,CAAC;YAC7D,MAAM,uBAAuB,GAAG,IAAA,WAAI,EAClC,cAAc,EACd,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAClB,cAAc,CACf,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,sBAAsB,CAAC,CAAC;gBAC3D,SAAS;YACX,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,KAAK,CAC3C,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,OAAO,CAAE,CAC7C,CAAC;YACF,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC/B,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,kCAAkC,CAAC,CAAC;gBACvE,SAAS;YACX,CAAC;YACD,MAAM,UAAU,GAAG,UAAU,IAAI,UAAU,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;gBACvE,OAAO,CAAC,GAAG,CACT,mBAAmB,IAAI,uCAAuC,CAC/D,CAAC;gBACF,SAAS;YACX,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CACvB,IAAI,CAAC,IAAI,CAAC,IAAA,WAAI,EAAC,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,EAAE,OAAO,CAAE,CAC1E,CAAC;YACF,IAAI,CAAC,CAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,IAAI,CAAA,EAAE,CAAC;gBAC7B,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,wBAAwB,CAAC,CAAC;gBAC7D,SAAS;YACX,CAAC;YACD,MAAM,qBAAqB,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;YAC7D,MAAM,yBAAyB,GAC7B,IAAA,WAAI,EAAC,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,KAAK,CAAC;YAC1E,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,EAAE,CAAC;gBAC5C,OAAO,CAAC,GAAG,CACT,mBAAmB,IAAI,+BAA+B;oBACpD,yBAAyB,CAC5B,CAAC;gBACF,SAAS;YACX,CAAC;YACD,8DAA8D;YAC9D,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,IAAA,WAAI,EAChC,cAAc,EACd,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAClB,qBAAqB,CACtB,CAAC,0CAAE,OAAO,CAAC;YACZ,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;gBACxC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,iCAAiC,CAAC,CAAC;gBACtE,SAAS;YACX,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,0CAA0C,IAAI,EAAE,CAAC,CAAC;YAC9D,MAAM,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;CAAA;AAED,kBAAe,aAAa,CAAC"}

package/src/generators/init/index.d.ts

@@ -0,0 +1,2 @@
+declare const schematic: (generatorOptions: import("./schema").InitGeneratorSchema) => (tree: any, context: any) => Promise<any>;
+export default schematic;

package/src/generators/init/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const generator_1 = require("./generator");
+const schematic = (0, devkit_1.convertNxGenerator)(generator_1.default);
+exports.default = schematic;
+//# sourceMappingURL=index.js.map

package/src/generators/init/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/llm/src/generators/init/index.ts"],"names":[],"mappings":";;AAAA,uCAAgD;AAChD,2CAAoC;AAEpC,MAAM,SAAS,GAAG,IAAA,2BAAkB,EAAC,mBAAS,CAAC,CAAC;AAChD,kBAAe,SAAS,CAAC"}

package/src/generators/init/schema.d.ts

@@ -0,0 +1,3 @@
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface InitGeneratorSchema {
+}

package/src/generators/init/schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "Init",
+  "title": "",
+  "type": "object",
+  "properties": {},
+  "required": []
+}

package/src/generators/package-description/generator.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import { PackageDescriptionGeneratorSchema } from './schema';
+export declare function packageDescriptionGenerator(tree: Tree, options: PackageDescriptionGeneratorSchema): Promise<void>;
+export default packageDescriptionGenerator;

package/src/generators/package-description/generator.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageDescriptionGenerator = packageDescriptionGenerator;
+const tslib_1 = require("tslib");
+const workspace_ts_morph_1 = require("@rxap/workspace-ts-morph");
+const workspace_utilities_1 = require("@rxap/workspace-utilities");
+const node_fs_1 = require("node:fs");
+const path_1 = require("path");
+const xml2js_1 = require("xml2js");
+const completion_1 = require("../../lib/completion");
+const compose_context_1 = require("../../lib/compose-context");
+const model_1 = require("../../lib/model");
+function projectToContext(project, packageName) {
+    const builder = new xml2js_1.Builder();
+    const context = { sourceFile: [], package: { _: packageName } };
+    for (const sourceFile of project.getSourceFiles()) {
+        context.sourceFile.push((0, compose_context_1.sourceFileToContextSourceFile)(sourceFile));
+    }
+    return builder.buildObject(context).replace(/root>/g, 'context>') + '\n';
+}
+function packageDescriptionGenerator(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { model = 'gemini/2.0-flash', apiKey, orgId, projectId, baseUrl, project: projectName } = options;
+        if (model && !Object.keys(model_1.tokenLimits).includes(model)) {
+            throw new Error(`The model '${model}' is not supported in the documentation generator`);
+        }
+        const projectConfiguration = (0, workspace_utilities_1.GetProject)(tree, projectName);
+        if (!(0, workspace_utilities_1.IsLibraryProject)(projectConfiguration)) {
+            console.log(`The project '${projectName}' is not a library project.`.yellow);
+            return;
+        }
+        if (!(0, workspace_utilities_1.IsPublishable)(tree, projectConfiguration)) {
+            console.log(`The project '${projectName}' is not intended to be published.`.yellow);
+            return;
+        }
+        if ((0, workspace_utilities_1.GetProjectPackageJson)(tree, projectName).description && !options.overwrite) {
+            console.log(`The project '${projectName}' has already a description. User --overwrite to replace the existing description`.yellow);
+            return;
+        }
+        const systemPrompt = (0, node_fs_1.readFileSync)((0, path_1.join)(__dirname, 'system-prompts', 'generic.txt'), 'utf-8');
+        let context = '';
+        (0, workspace_ts_morph_1.TsMorphTransform)(tree, (0, workspace_utilities_1.GetProjectSourceRoot)(tree, projectName), (project) => {
+            context = projectToContext(project, (0, workspace_utilities_1.GetProjectPackageJson)(tree, projectName).name);
+        });
+        const description = yield (0, completion_1.completion)(systemPrompt, context, { apiKey, projectId, orgId, baseUrl, model: model });
+        console.log('DESCRIPTION'.green + ' ' + description);
+        (0, workspace_utilities_1.UpdateProjectPackageJson)(tree, packageJson => {
+            packageJson.description = description;
+        }, { projectName });
+    });
+}
+exports.default = packageDescriptionGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/package-description/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/llm/src/generators/package-description/generator.ts"],"names":[],"mappings":";;AAqCA,kEA0CC;;AA9ED,iEAGkC;AAClC,mEAOmC;AACnC,qCAAuC;AACvC,+BAA4B;AAE5B,mCAAiC;AACjC,qDAAkD;AAClD,+DAGmC;AACnC,2CAGyB;AAGzB,SAAS,gBAAgB,CAAC,OAAgB,EAAE,WAAmB;IAC7D,MAAM,OAAO,GAAG,IAAI,gBAAO,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAG,EAAE,UAAU,EAAE,EAAyB,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC;IACvF,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;QAClD,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAA,+CAA6B,EAAC,UAAU,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC;AAC3E,CAAC;AAED,SAAsB,2BAA2B,CAC/C,IAAU,EACV,OAA0C;;QAE1C,MAAM,EAAC,KAAK,GAAG,kBAAkB,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;QAEvG,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAW,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,cAAc,KAAK,mDAAmD,CAAC,CAAC;QAC1F,CAAC;QAED,MAAM,oBAAoB,GAAG,IAAA,gCAAU,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAE3D,IAAI,CAAC,IAAA,sCAAgB,EAAC,oBAAoB,CAAC,EAAE,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC,gBAAgB,WAAW,6BAA6B,CAAC,MAAM,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAA,mCAAa,EAAC,IAAI,EAAE,oBAAoB,CAAC,EAAE,CAAC;YAC/C,OAAO,CAAC,GAAG,CAAC,gBAAgB,WAAW,oCAAoC,CAAC,MAAM,CAAC,CAAC;YACpF,OAAO;QACT,CAAC;QAED,IAAI,IAAA,2CAAqB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC,WAAW,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC/E,OAAO,CAAC,GAAG,CAAC,gBAAgB,WAAW,mFAAmF,CAAC,MAAM,CAAC,CAAC;YACnI,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,IAAA,sBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7F,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,IAAA,qCAAgB,EAAC,IAAI,EAAE,IAAA,0CAAoB,EAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,OAAgB,EAAE,EAAE;YACnF,OAAO,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAA,2CAAqB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,MAAM,IAAA,uBAAU,EAAC,YAAY,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAc,EAAE,CAAC,CAAC;QAE1H,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,GAAG,GAAG,GAAG,WAAW,CAAC,CAAC;QAErD,IAAA,8CAAwB,EAAC,IAAI,EAAE,WAAW,CAAC,EAAE;YAC3C,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC;QACxC,CAAC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAEtB,CAAC;CAAA;AAED,kBAAe,2BAA2B,CAAC"}

package/src/generators/package-description/index.d.ts

@@ -0,0 +1,2 @@
+declare const schematic: (generatorOptions: import("./schema").PackageDescriptionGeneratorSchema) => (tree: any, context: any) => Promise<any>;
+export default schematic;

package/src/generators/package-description/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const generator_1 = require("./generator");
+const schematic = (0, devkit_1.convertNxGenerator)(generator_1.default);
+exports.default = schematic;
+//# sourceMappingURL=index.js.map

package/src/generators/package-description/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/llm/src/generators/package-description/index.ts"],"names":[],"mappings":";;AAAA,uCAAgD;AAChD,2CAAoC;AAEpC,MAAM,SAAS,GAAG,IAAA,2BAAkB,EAAC,mBAAS,CAAC,CAAC;AAChD,kBAAe,SAAS,CAAC"}

package/src/generators/package-description/schema.d.ts

@@ -0,0 +1,15 @@
+export interface PackageDescriptionGeneratorSchema {
+  project: string;
+  /** The openai api key */
+  apiKey?: string;
+  /** The openai organization id */
+  orgId?: string;
+  /** The openai project id */
+  projectId?: string;
+  /** The openai base url */
+  baseUrl?: string;
+  /** Set the LLM model to be used */
+  model?: string;
+  /** Replaces the existing description files */
+  overwrite?: boolean;
+}

package/src/generators/package-description/schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "PackageDescription",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string"
+    },
+    "apiKey": {
+      "type": "string",
+      "description": "The openai api key"
+    },
+    "orgId": {
+      "type": "string",
+      "description": "The openai organization id"
+    },
+    "projectId": {
+      "type": "string",
+      "description": "The openai project id"
+    },
+    "baseUrl": {
+      "type": "string",
+      "description": "The openai base url"
+    },
+    "model": {
+      "type": "string",
+      "description": "Set the LLM model to be used",
+      "default": "gemini/2.0-flash"
+    },
+    "overwrite": {
+      "type": "boolean",
+      "description": "Replaces the existing description files"
+    }
+  },
+  "required": ["project"]
+}

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

@@ -0,0 +1,44 @@
+Your task is to generate a short description for an npm package based on the source code of the package
+
+The source code of the npm package is provided as context formatted according to the schema in the context.xsd file below.
+
+Use the following file contents as reference:
+
+-------------------- 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>
+                <!-- the name of the npm package -->
+                <xsd:element name="package" minOccurs="1" maxOccurs="1"/>
+                <!-- multiple 'sourceFile' elements -->
+                <xsd:element name="sourceFile" type="sourceFileType" minOccurs="0" maxOccurs="unbounded"/>
+            </xsd:sequence>
+        </xsd:complexType>
+    </xsd:element>
+
+</xsd:schema>
+------------------------------------------------------------
+
+Instructions:
+- Read the provided source code as structured by the context.xsd.
+- Create short one to three sentence description of the npm package
+- Output ONLY the description text without any other text
+
+Example Output:
+------------------------------------------------------------
+TypeScript Compiler API wrapper. Provides an easier way to programmatically navigate and manipulate TypeScript and JavaScript code.
+------------------------------------------------------------
+
+Remember:
+- The goal is to allow an developer to unterstand what this npm package offers
+- ONLY output the description of the npm package

package/src/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/plugin/llm/src/index.ts"],"names":[],"mappings":""}

package/src/lib/__snapshots__/cleanup-js-doc.spec.ts.snap

@@ -0,0 +1,32 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`cleanupJsDoc should remove comment prefix with complex example 1`] = `
+"A map of special characters to their ASCII representation. This map contains a comprehensive set of character mappings including currency symbols, diacritical marks, mathematical symbols, and various language-specific characters from different writing systems (Latin, Cyrillic, Georgian, etc.).
+
+@example
+\`\`\`typescript
+// Example of some mappings
+{
+  "£": "pound",
+  "€": "euro",
+  "Ä": "A",
+  "ß": "ss",
+  "Ж": "Zh"
+}
+\`\`\`
+
+@default A large JSON object containing character mappings for transliteration"
+`;
+
+exports[`cleanupJsDoc should remove comment prefix with simple example 1`] = `
+"@param string - The string to slugify.
+@param options - Options for slugifying the string.
+@param customMap - A custom map of characters to replace.
+@returns The slugified string.
+
+@example
+\`\`\`typescript
+slugify('hello world'); // 'hello-world'
+\`\`\`
+"
+`;

package/src/lib/add-js-doc.d.ts

@@ -0,0 +1,2 @@
+import { JSDocableNode } from 'ts-morph';
+export declare function addJsDoc(node: JSDocableNode, jsDoc: string): void;

package/src/lib/add-js-doc.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addJsDoc = addJsDoc;
+function addJsDoc(node, jsDoc) {
+    node.addJsDoc(jsDoc);
+}
+//# sourceMappingURL=add-js-doc.js.map

package/src/lib/add-js-doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-js-doc.js","sourceRoot":"","sources":["../../../../../../packages/plugin/llm/src/lib/add-js-doc.ts"],"names":[],"mappings":";;AAEA,4BAEC;AAFD,SAAgB,QAAQ,CAAC,IAAmB,EAAE,KAAa;IACzD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC"}

package/src/lib/assert-token-limit.d.ts

@@ -0,0 +1,2 @@
+import { Model } from './model';
+export declare function assertTokenLimit(model: Model, ...inputs: string[]): number;

package/src/lib/assert-token-limit.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertTokenLimit = assertTokenLimit;
+const count_tokens_1 = require("./count-tokens");
+const model_1 = require("./model");
+function assertTokenLimit(model, ...inputs) {
+    const sum = inputs.reduce((sum, input) => sum + (0, count_tokens_1.countTokens)(model, input), 0);
+    if (sum > model_1.tokenLimits[model][0] * 0.8) {
+        throw new Error(`The input has '${sum}' tokens and the model has a limit of ${model_1.tokenLimits[model][0] * 0.8}`);
+    }
+    return sum;
+}
+//# sourceMappingURL=assert-token-limit.js.map