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

package/README.md

@@ -0,0 +1,11 @@
+# plugins-kos-nx-plugin
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build plugins-kos-nx-plugin` to build the library.
+
+## Running unit tests
+
+Run `nx test plugins-kos-nx-plugin` to execute the unit tests via [Jest](https://jestjs.io).

package/generators.json

@@ -0,0 +1,80 @@
+{
+  "generators": {
+    "kos-model": {
+      "factory": "./src/generators/kos-model/generator",
+      "schema": "./src/generators/kos-model/schema.json",
+      "description": "Generate a KOS Model"
+    },
+    "kos-container-model": {
+      "factory": "./src/generators/kos-container-model/generator",
+      "schema": "./src/generators/kos-container-model/schema.json",
+      "description": "Generate a KOS Container Model for an existing model"
+    },
+    "kos-hook": {
+      "factory": "./src/generators/kos-hook/generator",
+      "schema": "./src/generators/kos-hook/schema.json",
+      "description": "Create a react hook for a KOS model"
+    },
+    "kos-component": {
+      "factory": "./src/generators/kos-component/generator",
+      "schema": "./src/generators/kos-component/schema.json",
+      "description": "Create a new React component that can be connected to a KOS model"
+    },
+    "kos-context": {
+      "factory": "./src/generators/kos-context/generator",
+      "schema": "./src/generators/kos-context/schema.json",
+      "description": "Create a React context that can be used to provide a KOS model to a component"
+    },
+    "kos-ui-project": {
+      "factory": "./src/generators/kos-ui-project/generator",
+      "schema": "./src/generators/kos-ui-project/schema.json",
+      "description": "Create a new UI Project for KOS"
+    },
+    "kos-plugin-project": {
+      "factory": "./src/generators/kos-plugin-project/generator",
+      "schema": "./src/generators/kos-plugin-project/schema.json",
+      "description": "Create a new plugin project for KOS"
+    },
+    "kos-theme-project": {
+      "factory": "./src/generators/kos-theme-project/generator",
+      "schema": "./src/generators/kos-theme-project/schema.json",
+      "description": "Create a new theme project for kos"
+    },
+    "kos-content-project": {
+      "factory": "./src/generators/kos-content-project/generator",
+      "schema": "./src/generators/kos-content-project/schema.json",
+      "description": "Create a new content project for KAB (Kos Asset Bundle) generation"
+    },
+    "kos-i18n-project": {
+      "factory": "./src/generators/kos-i18n-project/generator",
+      "schema": "./src/generators/kos-i18n-project/schema.json",
+      "description": "Create a new i18n project for kos"
+    },
+    "kos-init": {
+      "factory": "./src/generators/kos-init/generator",
+      "schema": "./src/generators/kos-init/schema.json",
+      "description": "kos-init generator"
+    },
+    "preset": {
+      "factory": "./src/generators/preset/generator",
+      "schema": "./src/generators/preset/schema.json",
+      "description": "preset generator",
+      "x-use-standalone-layout": true
+    },
+    "kos-companion-model": {
+      "factory": "./src/generators/kos-companion-model/generator",
+      "schema": "./src/generators/kos-companion-model/schema.json",
+      "description": "kos-companion-model generator"
+    },
+    "kos-splash-project": {
+      "factory": "./src/generators/kos-splash-project/generator",
+      "schema": "./src/generators/kos-splash-project/schema.json",
+      "description": "Generates a new project to create a KOS splash screen"
+    },
+    "kos-add-future-to-model": {
+      "factory": "./src/generators/kos-add-future-to-model/generator",
+      "schema": "./src/generators/kos-add-future-to-model/schema.json",
+      "description": "Add Future support to an existing KOS model"
+    }
+  }
+}

package/migrations.json

@@ -0,0 +1,86 @@
+{
+  "generators": {
+    "add-overrides": {
+      "version": "0.0.9",
+      "description": "add-overrides",
+      "cli": "nx",
+      "implementation": "./src/migrations/add-overrides/add-overrides"
+    },
+    "default-projects": {
+      "version": "0.1.164",
+      "description": "Add default KOS component projects",
+      "cli": "nx",
+      "implementation": "./src/migrations/default-projects/default-projects"
+    },
+    "update-sdk": {
+      "version": "0.1.165",
+      "description": "update-sdk",
+      "cli": "nx",
+      "implementation": "./src/migrations/update-sdk/update-sdk"
+    },
+    "translations": {
+      "version": "0.1.857",
+      "description": "adds kos translation support to existing projects",
+      "cli": "nx",
+      "implementation": "./src/migrations/translations/add-descriptor"
+    },
+    "extensions": {
+      "version": "0.1.1267",
+      "description": "migrates extensions to new format",
+      "cli": "nx",
+      "implementation": "./src/migrations/migrate-extensions/migrate-extensions"
+    },
+    "translation-format": {
+      "version": "0.1.1485",
+      "description": "migrates translations to new format",
+      "cli": "nx",
+      "implementation": "./src/migrations/translation-format/translation-format"
+    },
+    "freestyle-sdk": {
+      "version": "0.1.1580",
+      "description": "migrates scripts to allow updates of freestyle sdk",
+      "cli": "nx",
+      "implementation": "./src/migrations/freestyle-sdk/freestyle-sdk"
+    },
+    "cms-sdk": {
+      "version": "0.1.1667",
+      "description": "migrates scripts to allow updates of cms sdk",
+      "cli": "nx",
+      "implementation": "./src/migrations/cms-sdk/cms-sdk"
+    },
+    "update-kabtool": {
+      "version": "0.1.1759",
+      "description": "updates kabtool to support built automation",
+      "cli": "nx",
+      "implementation": "./src/migrations/update-kabtool/update-kabtool"
+    },
+    "add-update-tool": {
+      "version": "0.1.2297",
+      "description": "adds update tool to support automated dependency updates",
+      "cli": "nx",
+      "implementation": "./src/migrations/add-update-tool/migrate"
+    },
+    "kabtool-env": {
+      "version": "0.1.2297",
+      "description": "updates the kabtool to use the .env.local file",
+      "cli": "nx",
+      "implementation": "./src/migrations/kabtool-env/migrate"
+    },
+    "consolidate-sdk": {
+      "version": "1.6.0",
+      "description": "Migration for v1.6.0",
+      "implementation": "./src/migrations/consolidate-sdk/consolidate-sdk"
+    },
+    "update-sdk-2": {
+      "version": "2.0.0",
+      "description": "Migration for v2.0.0",
+      "implementation": "./src/migrations/update-sdk-2.0/update"
+    }
+  },
+  "packageJsonUpdates": {
+    "1.5.0": {
+      "version": "1.5.0",
+      "packages": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@kosdev-code/kos-nx-plugin",
+  "version": "0.1.0-dev.5053",
+  "type": "commonjs",
+  "generators": "./generators.json",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "scripts": {
+    "postinstall": ""
+  },
+  "nx-migrations": {
+    "migrations": "./migrations.json"
+  },
+  "dependencies": {
+    "@nx/devkit": "^17.2.8",
+    "@nx/react": "^17.2.8"
+  },
+  "main": "./src/index.js",
+  "kos": {
+    "build": {
+      "gitHash": "c98a36c0d6454b4648b4e9d014b0e57fcd1d39a1"
+    }
+  }
+}

package/src/generators/kos-add-future-to-model/README.md

@@ -0,0 +1,106 @@
+# Add Future Support to Existing KOS Model
+
+This generator adds Future support to an existing KOS model, transforming it to support progress tracking for long-running operations.
+
+## Usage
+
+### Via CLI
+```bash
+# Interactive mode - automatically discovers and lists all available models
+kos-cli add-future
+
+# With parameters
+kos-cli add-future --modelName=MyModel --futureType=minimal --project=my-project
+
+# Direct Nx
+nx generate @kosdev-code/kos-nx-plugin:kos-add-future-to-model --modelName=MyModel --modelProject=my-project --futureType=complete
+```
+
+### Parameters
+
+- `modelName` (required): Name of the existing model to add Future support to
+- `modelProject` (required): Project where the model is located  
+- `futureType`: Type of Future support (`minimal` or `complete`, defaults to `minimal`)
+- `updateServices`: Whether to update/create services file (defaults to `true`)
+- `dryRun`: Show what would be changed without making actual modifications
+
+## What It Does
+
+### Model File Changes
+- Adds Future-related imports
+- Adds Future properties (`futureHandler`, `future` for complete mode)
+- Adds mixin setup call in constructor
+- Adds `@kosFuture()` placeholder method
+- Updates public type with `ExternalFutureInterface` intersection
+- Adds `onFutureUpdate` method (for complete mode)
+- Updates class implements clause (for complete mode)
+
+### Services File Changes
+- Adds `FutureResponse` import
+- Creates placeholder Future operation service method
+- Adds progress and result type definitions
+- Creates file if it doesn't exist
+
+### Registration File Changes  
+- Adds `as any` type cast for intersection type
+- Updates documentation with Future capabilities
+- Adds Future usage examples
+
+## Example Transformation
+
+**Before:**
+```typescript
+export type MyModel = PublicModelInterface<MyModelImpl>;
+
+@kosModel(MODEL_TYPE)
+export class MyModelImpl implements IKosDataModel, IKosIdentifiable {
+  constructor(modelId: string, options: MyOptions, context: KosCreationContext) {
+    this.id = modelId;
+    this.logger = context.logger;
+  }
+}
+```
+
+**After (minimal):**
+```typescript
+import { kosFuture, setupMinimalFutureSupport } from "@kosdev-code/kos-ui-sdk";
+import type { ExternalFutureInterface, FutureAwareContainer } from "@kosdev-code/kos-ui-sdk";
+import type { MyOperationProgress } from "./services";
+
+export type MyModel = PublicModelInterface<MyModelImpl> & ExternalFutureInterface<MyOperationProgress>;
+
+@kosModel(MODEL_TYPE)
+export class MyModelImpl implements IKosDataModel, IKosIdentifiable {
+  // Future support properties - guaranteed by framework
+  public futureHandler!: FutureAwareContainer<MyOperationProgress>;
+  
+  constructor(modelId: string, options: MyOptions, context: KosCreationContext) {
+    this.id = modelId;
+    this.logger = context.logger;
+    
+    // Initialize Future support
+    setupMinimalFutureSupport(this);
+  }
+  
+  @kosFuture()
+  async performLongRunningOperation(): Promise<void> {
+    // TODO: Implement your long-running operation here
+    this.logger.debug(`Starting long-running operation for ${this.id}`);
+    await new Promise(resolve => setTimeout(resolve, 1000));
+    this.logger.debug(`Completed long-running operation for ${this.id}`);
+  }
+}
+```
+
+## Next Steps After Generation
+
+1. **Implement the @kosFuture method**: Replace the placeholder with your actual long-running operation
+2. **Update service method**: Implement the generated service method to return a proper `FutureResponse`
+3. **Define progress types**: Customize the `OperationProgress` and `OperationResult` types for your specific use case
+4. **Customize onFutureUpdate** (complete mode): Add custom logic for handling Future state changes
+
+## Error Handling
+
+- Validates that the model file exists before transformation
+- Provides clear error messages for missing files or invalid configurations
+- Supports dry-run mode to preview changes before applying them

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-add-future-to-model/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAe,MAAM,YAAY,CAAC;AAO/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAErD,wBAAsB,4BAA4B,CAChD,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,yBAAyB,iBAiFnC;AAED,eAAe,4BAA4B,CAAC"}

package/src/generators/kos-add-future-to-model/generator.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kosAddFutureToModelGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const logger_1 = require("../../utils/logger");
+const model_transformer_1 = require("./lib/model-transformer");
+const normalize_options_1 = require("./lib/normalize-options");
+const registration_transformer_1 = require("./lib/registration-transformer");
+const service_transformer_1 = require("./lib/service-transformer");
+async function kosAddFutureToModelGenerator(tree, options) {
+    const normalized = (0, normalize_options_1.normalizeOptions)(tree, options);
+    logger_1.logger.info(`Adding ${normalized.futureType} Future support to model: ${normalized.modelName}`);
+    // Validate that model file exists
+    if (!tree.exists(normalized.modelFilePath)) {
+        throw new Error(`Model file not found: ${normalized.modelFilePath}`);
+    }
+    if (options.dryRun) {
+        logger_1.logger.info("DRY RUN - No files will be modified");
+        logger_1.logger.info(`Would modify model file: ${normalized.modelFilePath}`);
+        if (normalized.servicesFilePath) {
+            logger_1.logger.info(`Would modify/create services file: ${normalized.servicesFilePath}`);
+        }
+        if (normalized.registrationFilePath) {
+            logger_1.logger.info(`Would modify registration file: ${normalized.registrationFilePath}`);
+        }
+        return;
+    }
+    try {
+        // Transform model file
+        logger_1.logger.info(`Transforming model file: ${normalized.modelFilePath}`);
+        const modelTransformer = new model_transformer_1.ModelFileTransformer(tree, normalized);
+        modelTransformer.transform();
+        // Transform or create services file
+        if (normalized.updateServices) {
+            logger_1.logger.info(`Transforming services file: ${normalized.servicesFilePath || "creating new"}`);
+            const serviceTransformer = new service_transformer_1.ServiceFileTransformer(tree, normalized);
+            serviceTransformer.transform();
+        }
+        // Transform registration file
+        if (normalized.registrationFilePath) {
+            logger_1.logger.info(`Transforming registration file: ${normalized.registrationFilePath}`);
+            const registrationTransformer = new registration_transformer_1.RegistrationFileTransformer(tree, normalized);
+            registrationTransformer.transform();
+        }
+        logger_1.logger.info(`✅ Successfully added ${normalized.futureType} Future support to ${normalized.modelName}`);
+        logger_1.logger.info("");
+        logger_1.logger.info("Next steps:");
+        logger_1.logger.info("1. Review the generated @kosFuture method and implement your actual operation");
+        logger_1.logger.info("2. Update the service method to return a proper FutureResponse");
+        logger_1.logger.info("3. Define your specific progress and result types");
+        if (normalized.futureType === "complete") {
+            logger_1.logger.info("4. Customize the onFutureUpdate method for your specific needs");
+        }
+    }
+    catch (error) {
+        logger_1.logger.error(`Failed to add Future support: ${error}`);
+        throw error;
+    }
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.kosAddFutureToModelGenerator = kosAddFutureToModelGenerator;
+exports.default = kosAddFutureToModelGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/kos-add-future-to-model/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-add-future-to-model/generator.ts"],"names":[],"mappings":";;;AAAA,uCAA+C;AAC/C,+CAA4C;AAE5C,+DAA+D;AAC/D,+DAA2D;AAC3D,6EAA6E;AAC7E,mEAAmE;AAG5D,KAAK,UAAU,4BAA4B,CAChD,IAAU,EACV,OAAkC;IAElC,MAAM,UAAU,GAAG,IAAA,oCAAgB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEnD,eAAM,CAAC,IAAI,CACT,UAAU,UAAU,CAAC,UAAU,6BAA6B,UAAU,CAAC,SAAS,EAAE,CACnF,CAAC;IAEF,kCAAkC;IAClC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,yBAAyB,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,eAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QACnD,eAAM,CAAC,IAAI,CAAC,4BAA4B,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC;QACpE,IAAI,UAAU,CAAC,gBAAgB,EAAE,CAAC;YAChC,eAAM,CAAC,IAAI,CACT,sCAAsC,UAAU,CAAC,gBAAgB,EAAE,CACpE,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,CAAC,oBAAoB,EAAE,CAAC;YACpC,eAAM,CAAC,IAAI,CACT,mCAAmC,UAAU,CAAC,oBAAoB,EAAE,CACrE,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,uBAAuB;QACvB,eAAM,CAAC,IAAI,CAAC,4BAA4B,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC;QACpE,MAAM,gBAAgB,GAAG,IAAI,wCAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACpE,gBAAgB,CAAC,SAAS,EAAE,CAAC;QAE7B,oCAAoC;QACpC,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;YAC9B,eAAM,CAAC,IAAI,CACT,+BACE,UAAU,CAAC,gBAAgB,IAAI,cACjC,EAAE,CACH,CAAC;YACF,MAAM,kBAAkB,GAAG,IAAI,4CAAsB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACxE,kBAAkB,CAAC,SAAS,EAAE,CAAC;QACjC,CAAC;QAED,8BAA8B;QAC9B,IAAI,UAAU,CAAC,oBAAoB,EAAE,CAAC;YACpC,eAAM,CAAC,IAAI,CACT,mCAAmC,UAAU,CAAC,oBAAoB,EAAE,CACrE,CAAC;YACF,MAAM,uBAAuB,GAAG,IAAI,sDAA2B,CAC7D,IAAI,EACJ,UAAU,CACX,CAAC;YACF,uBAAuB,CAAC,SAAS,EAAE,CAAC;QACtC,CAAC;QAED,eAAM,CAAC,IAAI,CACT,wBAAwB,UAAU,CAAC,UAAU,sBAAsB,UAAU,CAAC,SAAS,EAAE,CAC1F,CAAC;QACF,eAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChB,eAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,eAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;QACF,eAAM,CAAC,IAAI,CACT,gEAAgE,CACjE,CAAC;QACF,eAAM,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;QACjE,IAAI,UAAU,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;YACzC,eAAM,CAAC,IAAI,CACT,gEAAgE,CACjE,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,eAAM,CAAC,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;QACvD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAnFD,oEAmFC;AAED,kBAAe,4BAA4B,CAAC"}

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

@@ -0,0 +1,22 @@
+import { Tree } from "@nx/devkit";
+import { NormalizedKosAddFutureToModelSchema } from "../schema";
+/**
+ * Transformer that updates existing models to use the new @kosFutureAware decorator pattern
+ * with TypeScript interface merging for type safety.
+ */
+export declare class ModelFileTransformer {
+    private tree;
+    private options;
+    constructor(tree: Tree, options: NormalizedKosAddFutureToModelSchema);
+    transform(): void;
+    private addESLintDisable;
+    private addImports;
+    private addServiceImport;
+    private addInterfaceMerging;
+    private addDecorator;
+    private updatePublicType;
+    private removeLegacySetup;
+    private addFutureMethod;
+    private addOnFutureUpdateMethod;
+}
+//# sourceMappingURL=model-transformer.d.ts.map

package/src/generators/kos-add-future-to-model/lib/model-transformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-transformer.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-add-future-to-model/lib/model-transformer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,mCAAmC,EAAE,MAAM,WAAW,CAAC;AAEhE;;;GAGG;AACH,qBAAa,oBAAoB;IAE7B,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,OAAO;gBADP,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,mCAAmC;IAGtD,SAAS,IAAI,IAAI;IAyBjB,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,UAAU;IA6GlB,OAAO,CAAC,gBAAgB;IA+CxB,OAAO,CAAC,mBAAmB;IAqC3B,OAAO,CAAC,YAAY;IA2BpB,OAAO,CAAC,gBAAgB;IAwBxB,OAAO,CAAC,iBAAiB;IA4BzB,OAAO,CAAC,eAAe;IA+DvB,OAAO,CAAC,uBAAuB;CA8ChC"}