@kosdev-code/kos-nx-plugin 0.1.0-dev.5053

package/src/generators/kos-add-future-to-model/lib/service-transformer.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceFileTransformer = void 0;
+class ServiceFileTransformer {
+    tree;
+    options;
+    constructor(tree, options) {
+        this.tree = tree;
+        this.options = options;
+    }
+    transform() {
+        const { servicesFilePath } = this.options;
+        if (!servicesFilePath || !this.tree.exists(servicesFilePath)) {
+            // Create services file if it doesn't exist
+            this.createServicesFile();
+            return;
+        }
+        let content = this.tree.read(servicesFilePath, "utf-8");
+        content = this.addFutureImports(content);
+        content = this.addFutureService(content);
+        content = this.addProgressTypes(content);
+        this.tree.write(servicesFilePath, content);
+    }
+    createServicesFile() {
+        const { servicesFilePath, nameProperCase, nameDashCase, nameLowerCase } = this.options;
+        if (!servicesFilePath) {
+            return;
+        }
+        const content = `import {
+  KosLog,
+  type ClientResponse,
+  type DeepRequired,
+  type ElementType,
+  type ServiceResponse,
+  type FutureResponse
+} from '@kosdev-code/kos-ui-sdk';
+
+import API, { type KosApi, type ApiPath } from '../../../utils/service';
+
+const log = KosLog.createLogger({name: "${nameDashCase}-service", group: "Services"});
+
+const SERVICE_PATH: ApiPath = "ENTER_SERVICE_PATH"
+export type ${nameProperCase}ClientResponse = ClientResponse<
+  KosApi,
+  typeof SERVICE_PATH,
+  'get'
+>;
+export type ${nameProperCase}Response = DeepRequired<${nameProperCase}ClientResponse>;
+
+/**
+ * @category Service
+ * Retrieves the initial ${nameLowerCase} data.
+ */
+export const get${nameProperCase} = async (): Promise<ServiceResponse<${nameProperCase}Response>> => {
+  log.debug('sending GET for ${nameLowerCase}');
+  return await API.get(SERVICE_PATH);
+};
+
+/**
+ * @category Service - Future Operation
+ * Placeholder for a long-running operation that returns a Future for progress tracking
+ * 
+ * Replace this with your actual long-running service operation
+ */
+export const perform${nameProperCase}Operation = async (): Promise<FutureResponse> => {
+  // TODO: Implement your long-running service operation here
+  // This should return a Future that can be tracked for progress
+  
+  log.debug('starting long-running ${nameLowerCase} operation');
+  
+  // Example pattern:
+  // return API.post(OPERATION_SERVICE_PATH, {
+  //   // operation parameters
+  // });
+  
+  // Placeholder - replace with actual implementation
+  throw new Error('perform${nameProperCase}Operation not yet implemented');
+};
+
+// Additional Future-aware service types (add as needed)
+export type ${nameProperCase}OperationProgress = {
+  // Define your progress data structure here
+  stage: string;
+  percentComplete: number;
+  currentItem?: string;
+  totalItems?: number;
+};
+
+export type ${nameProperCase}OperationResult = {
+  // Define your operation result structure here
+  success: boolean;
+  message?: string; 
+  data?: any;
+};
+`;
+        this.tree.write(servicesFilePath, content);
+    }
+    addFutureImports(content) {
+        // Check if FutureResponse is already imported
+        if (content.includes("FutureResponse")) {
+            return content;
+        }
+        // Add FutureResponse to existing import
+        const importRegex = /import {\s*([^}]*)\s*} from '@kosdev-code\/kos-ui-sdk';/;
+        const importMatch = content.match(importRegex);
+        if (importMatch) {
+            const existingImports = importMatch[1];
+            if (existingImports.includes("FutureResponse")) {
+                return content; // Already imported
+            }
+            // Clean up existing imports and add FutureResponse
+            const cleanedImports = existingImports.trim().replace(/,\s*$/, ''); // Remove trailing comma
+            const newImports = cleanedImports
+                ? `${cleanedImports},\n  type FutureResponse`
+                : `type FutureResponse`;
+            const newImportStatement = `import {\n  ${newImports}\n} from '@kosdev-code/kos-ui-sdk';`;
+            return content.replace(importMatch[0], newImportStatement);
+        }
+        return content;
+    }
+    addFutureService(content) {
+        const { nameProperCase, nameLowerCase } = this.options;
+        // Check if Future service already exists
+        if (content.includes(`perform${nameProperCase}Operation`)) {
+            return content;
+        }
+        const futureService = `
+/**
+ * @category Service - Future Operation
+ * Placeholder for a long-running operation that returns a Future for progress tracking
+ * 
+ * Replace this with your actual long-running service operation
+ */
+export const perform${nameProperCase}Operation = async (): Promise<FutureResponse> => {
+  // TODO: Implement your long-running service operation here
+  // This should return a Future that can be tracked for progress
+  
+  log.debug('starting long-running ${nameLowerCase} operation');
+  
+  // Example pattern:
+  // return API.post(OPERATION_SERVICE_PATH, {
+  //   // operation parameters
+  // });
+  
+  // Placeholder - replace with actual implementation
+  throw new Error('perform${nameProperCase}Operation not yet implemented');
+};`;
+        // Add at the end of the file
+        return content + "\n" + futureService;
+    }
+    addProgressTypes(content) {
+        const { nameProperCase } = this.options;
+        // Check if progress types already exist
+        if (content.includes(`${nameProperCase}OperationProgress`)) {
+            return content;
+        }
+        const progressTypes = `
+// Additional Future-aware service types (add as needed)
+export type ${nameProperCase}OperationProgress = {
+  // Define your progress data structure here
+  stage: string;
+  percentComplete: number;
+  currentItem?: string;
+  totalItems?: number;
+};
+
+export type ${nameProperCase}OperationResult = {
+  // Define your operation result structure here
+  success: boolean;
+  message?: string; 
+  data?: any;
+};`;
+        // Add at the end of the file
+        return content + "\n" + progressTypes;
+    }
+}
+exports.ServiceFileTransformer = ServiceFileTransformer;
+//# sourceMappingURL=service-transformer.js.map

package/src/generators/kos-add-future-to-model/lib/service-transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-transformer.js","sourceRoot":"","sources":["../../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-add-future-to-model/lib/service-transformer.ts"],"names":[],"mappings":";;;AAGA,MAAa,sBAAsB;IAEvB;IACA;IAFV,YACU,IAAU,EACV,OAA4C;QAD5C,SAAI,GAAJ,IAAI,CAAM;QACV,YAAO,GAAP,OAAO,CAAqC;IACnD,CAAC;IAEJ,SAAS;QACP,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAE1C,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC7D,2CAA2C;YAC3C,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAE,CAAC;QAEzD,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAEzC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEO,kBAAkB;QACxB,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,GACrE,IAAI,CAAC,OAAO,CAAC;QAEf,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG;;;;;;;;;;;0CAWsB,YAAY;;;cAGxC,cAAc;;;;;cAKd,cAAc,2BAA2B,cAAc;;;;2BAI1C,aAAa;;kBAEtB,cAAc,wCAAwC,cAAc;+BACvD,aAAa;;;;;;;;;;sBAUtB,cAAc;;;;qCAIC,aAAa;;;;;;;;4BAQtB,cAAc;;;;cAI5B,cAAc;;;;;;;;cAQd,cAAc;;;;;;CAM3B,CAAC;QAEE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEO,gBAAgB,CAAC,OAAe;QACtC,8CAA8C;QAC9C,IAAI,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACvC,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,wCAAwC;QACxC,MAAM,WAAW,GACf,yDAAyD,CAAC;QAC5D,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAE/C,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACvC,IAAI,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC/C,OAAO,OAAO,CAAC,CAAC,mBAAmB;YACrC,CAAC;YAED,mDAAmD;YACnD,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,wBAAwB;YAC5F,MAAM,UAAU,GAAG,cAAc;gBAC/B,CAAC,CAAC,GAAG,cAAc,0BAA0B;gBAC7C,CAAC,CAAC,qBAAqB,CAAC;YAE1B,MAAM,kBAAkB,GAAG,eAAe,UAAU,qCAAqC,CAAC;YAC1F,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,gBAAgB,CAAC,OAAe;QACtC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEvD,yCAAyC;QACzC,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAU,cAAc,WAAW,CAAC,EAAE,CAAC;YAC1D,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,MAAM,aAAa,GAAG;;;;;;;sBAOJ,cAAc;;;;qCAIC,aAAa;;;;;;;;4BAQtB,cAAc;GACvC,CAAC;QAEA,6BAA6B;QAC7B,OAAO,OAAO,GAAG,IAAI,GAAG,aAAa,CAAC;IACxC,CAAC;IAEO,gBAAgB,CAAC,OAAe;QACtC,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAExC,wCAAwC;QACxC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,cAAc,mBAAmB,CAAC,EAAE,CAAC;YAC3D,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,MAAM,aAAa,GAAG;;cAEZ,cAAc;;;;;;;;cAQd,cAAc;;;;;GAKzB,CAAC;QAEA,6BAA6B;QAC7B,OAAO,OAAO,GAAG,IAAI,GAAG,aAAa,CAAC;IACxC,CAAC;CACF;AAnMD,wDAmMC"}

package/src/generators/kos-add-future-to-model/schema.d.ts

@@ -0,0 +1,24 @@
+export interface KosAddFutureToModelSchema {
+  modelName: string;
+  modelProject: string;
+  futureType: "minimal" | "complete";
+  modelPath?: string;
+  updateServices?: boolean;
+  dryRun?: boolean;
+}
+
+export interface NormalizedKosAddFutureToModelSchema
+  extends KosAddFutureToModelSchema {
+  nameDashCase: string;
+  nameProperCase: string;
+  nameCamelCase: string;
+  namePascalCase: string;
+  nameConstantCase: string;
+  nameLowerCase: string;
+  projectRoot: string;
+  sourceRoot: string;
+  modelFilePath: string;
+  servicesFilePath?: string;
+  registrationFilePath?: string;
+  internal: boolean;
+}

package/src/generators/kos-add-future-to-model/schema.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "KosAddFutureToModel",
+  "title": "Add Future Support to Existing KOS Model",
+  "type": "object",
+  "properties": {
+    "modelName": {
+      "type": "string",
+      "description": "Name of the existing model to add Future support to",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "Which model do you want to add Future support to?"
+    },
+    "modelProject": {
+      "type": "string",
+      "description": "The project where the model is located",
+      "x-prompt": "Which project contains the model?",
+      "x-dropdown": "projects"
+    },
+    "futureType": {
+      "type": "string",
+      "description": "Type of Future support to add",
+      "enum": ["minimal", "complete"],
+      "default": "minimal",
+      "x-prompt": {
+        "message": "What type of Future support?",
+        "type": "list",
+        "items": [
+          {
+            "value": "minimal",
+            "label": "Minimal (external access only)"
+          },
+          {
+            "value": "complete",
+            "label": "Complete (internal + external access)"
+          }
+        ]
+      }
+    },
+    "modelPath": {
+      "type": "string",
+      "description": "Relative path to the model file within the project (optional - will be auto-detected)"
+    },
+    "updateServices": {
+      "type": "boolean",
+      "description": "Update the services file to include Future operations",
+      "default": true,
+      "x-prompt": "Update services file with Future operations?"
+    },
+    "dryRun": {
+      "type": "boolean",
+      "description": "Show what would be changed without making actual changes",
+      "default": false
+    }
+  },
+  "required": ["modelName", "modelProject"]
+}

package/src/generators/kos-companion-model/files/types/index.d.ts.template

@@ -0,0 +1,11 @@
+import type { IKosCompanionOptions } from "@kosdev-code/kos-ui-sdk";
+import type { <%= modelNameProperCase %>Options, <%= modelNameProperCase %>Model } from "<%= importPath %>";
+
+
+export type <%= companionModelNameProperCase %>Options = IKosCompanionOptions<
+  <%= modelNameProperCase %>Model,
+  <%= modelNameProperCase %>Options
+>;
+
+
+

package/src/generators/kos-companion-model/generator.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from "@nx/devkit";
+import { KosCompanionModelGeneratorSchema } from "./schema";
+export declare function kosCompanionModelGenerator(tree: Tree, options: KosCompanionModelGeneratorSchema): Promise<void>;
+export default kosCompanionModelGenerator;
+//# sourceMappingURL=generator.d.ts.map

package/src/generators/kos-companion-model/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-companion-model/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,IAAI,EACL,MAAM,YAAY,CAAC;AAKpB,OAAO,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAE5D,wBAAsB,0BAA0B,CAC9C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,gCAAgC,iBAyD1C;AAED,eAAe,0BAA0B,CAAC"}

package/src/generators/kos-companion-model/generator.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kosCompanionModelGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const path = require("path");
+const logger_1 = require("../../utils/logger");
+const normalize_value_1 = require("../../utils/normalize-value");
+const project_utils_1 = require("../../utils/project-utils");
+async function kosCompanionModelGenerator(tree, options) {
+    const normalized = (0, normalize_value_1.normalizeAllValues)({
+        companionModelName: options.companionModelName,
+        modelName: options.modelName,
+    });
+    const companionModelChildName = options.companionModelName;
+    logger_1.logger.info(`Companion model child name ${companionModelChildName}`);
+    const companionModelChildProjectName = options.companionModelProject;
+    logger_1.logger.info(`Companion model child project name ${companionModelChildProjectName}`);
+    const companionModelParentName = options.modelName;
+    logger_1.logger.info(`Companion model parent name ${companionModelParentName}`);
+    const companionModelParentProjectName = options.modelProject;
+    const modelProjectName = options.modelProject;
+    const companionChildKosConfig = (0, project_utils_1.getKosProjectConfiguration)(tree, companionModelChildProjectName);
+    const modelProjectConfiguration = await (0, devkit_1.readProjectConfiguration)(tree, companionModelParentProjectName);
+    const companionChildProjectConfig = await (0, devkit_1.readProjectConfiguration)(tree, companionModelChildProjectName);
+    const projectRoot = companionChildProjectConfig.sourceRoot;
+    logger_1.logger.info(`Companion child source root ${projectRoot}`);
+    if (projectRoot) {
+        const pkgJsonPath = modelProjectConfiguration
+            ? path.join(modelProjectConfiguration.root, "package.json")
+            : "";
+        const importPath = pkgJsonPath ? (0, devkit_1.readJson)(tree, pkgJsonPath).name : "";
+        const modelLocation = companionChildKosConfig?.generator?.defaults?.model?.folder || "";
+        const filePath = path.join(projectRoot, modelLocation, normalized.companionModelNameDashCase);
+        logger_1.logger.info(`Overwriting companion model in ${filePath}`);
+        (0, devkit_1.generateFiles)(tree, path.join(__dirname, "files"), filePath, {
+            ...options,
+            ...normalized,
+            importPath,
+        });
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.kosCompanionModelGenerator = kosCompanionModelGenerator;
+exports.default = kosCompanionModelGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/kos-companion-model/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-companion-model/generator.ts"],"names":[],"mappings":";;;AAAA,uCAMoB;AACpB,6BAA6B;AAC7B,+CAA4C;AAC5C,iEAAiE;AACjE,6DAAuE;AAGhE,KAAK,UAAU,0BAA0B,CAC9C,IAAU,EACV,OAAyC;IAEzC,MAAM,UAAU,GAAG,IAAA,oCAAkB,EAAC;QACpC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;QAC9C,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;IAEH,MAAM,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAC3D,eAAM,CAAC,IAAI,CAAC,8BAA8B,uBAAuB,EAAE,CAAC,CAAC;IACrE,MAAM,8BAA8B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IACrE,eAAM,CAAC,IAAI,CACT,sCAAsC,8BAA8B,EAAE,CACvE,CAAC;IACF,MAAM,wBAAwB,GAAG,OAAO,CAAC,SAAS,CAAC;IAEnD,eAAM,CAAC,IAAI,CAAC,+BAA+B,wBAAwB,EAAE,CAAC,CAAC;IACvE,MAAM,+BAA+B,GAAG,OAAO,CAAC,YAAY,CAAC;IAE7D,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC;IAE9C,MAAM,uBAAuB,GAAG,IAAA,0CAA0B,EACxD,IAAI,EACJ,8BAA8B,CAC/B,CAAC;IACF,MAAM,yBAAyB,GAAG,MAAM,IAAA,iCAAwB,EAC9D,IAAI,EACJ,+BAA+B,CAChC,CAAC;IAEF,MAAM,2BAA2B,GAAG,MAAM,IAAA,iCAAwB,EAChE,IAAI,EACJ,8BAA8B,CAC/B,CAAC;IAEF,MAAM,WAAW,GAAG,2BAA2B,CAAC,UAAU,CAAC;IAC3D,eAAM,CAAC,IAAI,CAAC,+BAA+B,WAAW,EAAE,CAAC,CAAC;IAC1D,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,WAAW,GAAG,yBAAyB;YAC3C,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,cAAc,CAAC;YAC3D,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,IAAA,iBAAQ,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,MAAM,aAAa,GACjB,uBAAuB,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CACxB,WAAW,EACX,aAAa,EACb,UAAU,CAAC,0BAA0B,CACtC,CAAC;QAEF,eAAM,CAAC,IAAI,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;QAC1D,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE;YAC3D,GAAG,OAAO;YACV,GAAG,UAAU;YACb,UAAU;SACX,CAAC,CAAC;QACH,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AA3DD,gEA2DC;AAED,kBAAe,0BAA0B,CAAC"}

package/src/generators/kos-companion-model/schema.d.ts

@@ -0,0 +1,7 @@
+export interface KosCompanionModelGeneratorSchema {
+  companionModelName: string;
+  companionModelProject: string;
+  modelName: string;
+  modelProject: string;
+  companionPattern?: "composition" | "decorator";
+}

package/src/generators/kos-companion-model/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "KosCompanionModel",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "companionModelName": {
+      "type": "string",
+      "description": "",
+      "x-prompt": "What is the name of the companion model?"
+    },
+    "companionModelProject": {
+      "type": "string",
+      "description": "The project where the model will be located.",
+      "x-prompt": "Which project will this model be located in?",
+      "x-dropdown": "projects"
+    },
+    "modelName": {
+      "type": "string",
+      "description": "",
+      "x-prompt": "What is the name of the companion model parent?"
+    },
+    "modelProject": {
+      "type": "string",
+      "description": "The project where the model parent will be located.",
+      "x-prompt": "Which project will this model's parent be located in?",
+      "x-dropdown": "projects"
+    }
+  },
+  "required": [
+    "companionModelName",
+    "companionModelProject",
+    "modelName",
+    "modelProject"
+  ]
+}