@kosdev-code/kos-codegen-core 3.0.20 → 3.0.22

package/lib/generators/registration/upsert-chain-entry.d.ts

@@ -0,0 +1,13 @@
+export interface UpsertChainEntryResult {
+    changed: boolean;
+    /** The full file text after the edit (only when `changed`). */
+    content?: string;
+    /** Whether an import for the bean had to be added (only when `changed`). */
+    importAdded?: boolean;
+    note?: string;
+    error?: string;
+}
+/** Number of `.model(...)` entries in a chain file. */
+export declare function countChainEntries(content: string): number;
+export declare function upsertChainEntry(content: string, bean: string, importSpec: string): UpsertChainEntryResult;
+//# sourceMappingURL=upsert-chain-entry.d.ts.map

package/lib/generators/registration/upsert-chain-entry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsert-chain-entry.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-codegen-core/src/lib/generators/registration/upsert-chain-entry.ts"],"names":[],"mappings":"AAcA,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAwCD,uDAAuD;AACvD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GACjB,sBAAsB,CA4CxB"}

package/lib/generators/service-catalog.d.ts

@@ -35,5 +35,17 @@ export interface ServiceCatalogQuery {
  * should tell the user to run `api:generate`, not treat it as "no endpoints".
  */
 export declare function listServiceCatalog(codegenFs: CodegenFileSystem, query: ServiceCatalogQuery, projects?: Map<string, ProjectConfiguration>): ServiceCatalogEntry[];
+/**
+ * The operations a generated service module types, for callers that hold the
+ * module rather than a project name — path validation, above all.
+ *
+ * `paths` normally lives in the `openapi.d.ts` beside the module, but the module
+ * may declare it inline instead. Returns null when NEITHER does: that is "these
+ * types cannot answer the question", which a caller must not read as "the
+ * endpoint does not exist".
+ *
+ * @param serviceModuleFile Root-relative path of the module, with or without `.ts`.
+ */
+export declare function readServiceModuleOperations(codegenFs: CodegenFileSystem, serviceModuleFile: string): ServiceOperation[] | null;
 export {};
 //# sourceMappingURL=service-catalog.d.ts.map

package/lib/generators/service-catalog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service-catalog.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-codegen-core/src/lib/generators/service-catalog.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAIjE,8EAA8E;AAC9E,QAAA,MAAM,eAAe,oDAAqD,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,aAAa,CAAC;IACtB,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAID,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,iBAAiB,EAC5B,KAAK,EAAE,mBAAmB,EAC1B,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,GAC3C,mBAAmB,EAAE,CAiCvB"}
+{"version":3,"file":"service-catalog.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-codegen-core/src/lib/generators/service-catalog.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAIjE,8EAA8E;AAC9E,QAAA,MAAM,eAAe,oDAAqD,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,aAAa,CAAC;IACtB,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAID,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,iBAAiB,EAC5B,KAAK,EAAE,mBAAmB,EAC1B,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,GAC3C,mBAAmB,EAAE,CAiCvB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,iBAAiB,EAC5B,iBAAiB,EAAE,MAAM,GACxB,gBAAgB,EAAE,GAAG,IAAI,CAa3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kosdev-code/kos-codegen-core",
-  "version": "3.0.20",
+  "version": "3.0.22",
   "type": "commonjs",
   "main": "./index.js",
   "module": "./index.mjs",
@@ -25,7 +25,7 @@
   },
   "kos": {
     "build": {
-      "gitHash": "3dbe0f1e25c641a7273ef1a86408a9c35081a534"
+      "gitHash": "b64d9a0431aa83daea7eba6b84d7b39db7d47ea9"
     }
   }
 }

package/templates/kos-container-model/model/types/index.d.ts.template

@@ -1,10 +1,10 @@
 
-<% if (parentAware) { %>import type {KosParentAware} from  "@kosdev-code/kos-ui-sdk";<% } %>
+<% if (locals.parentAware) { %>import type {KosParentAware} from  "@kosdev-code/kos-ui-sdk";<% } %>
 
 
 // ---------------  <%= modelNameProperCase %> ---------------
 
-export interface <%= modelNameProperCase %>Options <% if (parentAware) { %>extends KosParentAware<% } %>  {
+export interface <%= modelNameProperCase %>Options <% if (locals.parentAware) { %>extends KosParentAware<% } %>  {
     
 }
 

package/templates/kos-model/model/__nameDashCase__-model.ts.template

@@ -9,7 +9,7 @@ import type {
   IKosDataModel,
   KosContextLogger
 } from "../../../core/core/kosModel";
-import type { KosModelRegistrationType } from "../../../core/core/registration/model-registration";
+import type { KosRegistrationFor } from "../../../core/core/registration/model-registration";
 import type { IKosIdentifiable } from "../../../core/core/types";
 import type { PublicModelInterface } from "../../../core/types";
 <% if (hasFutureSupport) { %>import type { 
@@ -17,7 +17,7 @@ import type { PublicModelInterface } from "../../../core/types";
   IFutureModel
 } from "../../../models/types/future-interfaces";<% } %>
 <% if (isDecoratorCompanion) { %>import { KosCompanionDecorator } from "../../../core/core/decorators";<% } %>
-<% } else { %>import type { IKosDataModel, IKosIdentifiable, PublicModelInterface, KosModelRegistrationType<% if (hasFutureSupport) { %>, ExternalFutureInterface, IFutureModel<% } %><% if (isDecoratorCompanion) { %>, KosCompanionDecorator<% } %>  } from "@kosdev-code/kos-ui-sdk";
+<% } else { %>import type { IKosDataModel, IKosIdentifiable, PublicModelInterface, KosRegistrationFor<% if (hasFutureSupport) { %>, ExternalFutureInterface, IFutureModel<% } %><% if (isDecoratorCompanion) { %>, KosCompanionDecorator<% } %>  } from "@kosdev-code/kos-ui-sdk";
 import { kosModel<% if (parentAware) { %>, kosParentAware<% } %><% if (hasFutureSupport) { %>, kosFuture, kosFutureAware, Kos<% if (isCompleteFuture) { %>FutureAwareFull<% } else { %>FutureAwareMinimal<% } %><% } %><% if (isDecoratorCompanion) { %>, kosCompanion<% } %>, kosLoggerAware, KosLoggerAware } from "@kosdev-code/kos-ui-sdk";
 <% } %>
 import type { <%= nameProperCase %>Options} from "./types";
@@ -34,14 +34,17 @@ export type <%= nameProperCase %>Model = PublicModelInterface<<%= nameProperCase
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface <%= nameProperCase %>ModelImpl extends KosLoggerAware<% if (hasFutureSupport) { %>, Kos<% if (isCompleteFuture) { %>FutureAwareFull<% } else { %>FutureAwareMinimal<% } %><<%= nameProperCase %>OperationProgress><% } %><% if (isDecoratorCompanion) { %>, KosCompanionDecorator<<%= companionModelProperCase %>Model><% } %> {}
 
-@kosModel({ modelTypeId: MODEL_TYPE<% if (singleton !== undefined) { %>, singleton: <%= singleton %><% } %><% if (autoRegister) { %>, autoRegister: true<% } %> })
+// Flipping `singleton` here moves the Registration type with it.
+export const MODEL_CONFIG = { modelTypeId: MODEL_TYPE, singleton: <%= singleton ? "true" : "false" %><% if (autoRegister) { %>, autoRegister: true<% } %> } as const;
+
+@kosModel(MODEL_CONFIG)
 <% if (parentAware && !isDecoratorCompanion) { %>@kosParentAware()<% } %>
 <% if (hasFutureSupport) { %>@kosFutureAware(<% if (!isCompleteFuture) { %>{ mode: 'minimal' }<% } %>)<% } %>
 <% if (isDecoratorCompanion) { %>@kosCompanion()<% } %>
 @kosLoggerAware()
 export class <%= nameProperCase %>ModelImpl implements  IKosDataModel, IKosIdentifiable  {
     // Registration property for type safety - actual value injected by @kosModel decorator
-    static Registration: KosModelRegistrationType<<%= nameProperCase %>Model, <%= nameProperCase %>Options>;
+    static Registration: KosRegistrationFor<typeof MODEL_CONFIG, <%= nameProperCase %>Model, <%= nameProperCase %>Options>;
 
     id: string;
     // logger property is automatically provided by @kosLoggerAware decorator

package/templates/kos-model-project/project/.eslintrc.json.template

@@ -0,0 +1,33 @@
+{
+  "extends": ["<%= offsetFromRoot %>.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": [
+          "error",
+          {
+            "ignoredFiles": [
+              "{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}",
+              "{projectRoot}/vite.config.{js,ts,mjs,mts}"
+            ]
+          }
+        ]
+      }
+    }
+  ]
+}

package/templates/kos-model-project/project/.kos.json.template

@@ -0,0 +1,14 @@
+{
+  "name": "<%= projectName %>",
+  "type": "kos.model",
+  "version": "0.0.0-SNAPSHOT",
+  "models": {},
+  "generator": {
+    "projectType": "model",
+    "defaults": {
+      "model": {
+        "folder": "models"
+      }
+    }
+  }
+}

package/templates/kos-model-project/project/README.md.template

@@ -0,0 +1,7 @@
+# <%= projectName %>
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build <%= projectName %>` to build the library.

package/templates/kos-model-project/project/package.json.template

@@ -0,0 +1,9 @@
+{
+  "name": "<%= importPath %>",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "dependencies": {}
+}

package/templates/kos-model-project/project/project.json.template

@@ -0,0 +1,35 @@
+{
+  "name": "<%= projectName %>",
+  "$schema": "<%= offsetFromRoot %>node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "<%= projectRoot %>/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/vite:build",
+      "outputs": ["{options.outputPath}"],
+      "defaultConfiguration": "production",
+      "options": {
+        "outputPath": "dist/<%= projectRoot %>"
+      },
+      "configurations": {
+        "development": {
+          "mode": "development"
+        },
+        "production": {
+          "mode": "production"
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    },
+    "api": {
+      "command": "kosui api:generate --project=<%= projectName %>",
+      "options": {
+        "host": "http://127.0.0.1:8081",
+        "defaultVersion": "snapshot"
+      }
+    }
+  }
+}

package/templates/kos-model-project/project/src/index.ts.template

@@ -0,0 +1 @@
+export * from './lib/<%= projectName %>';

package/templates/kos-model-project/project/src/lib/__projectName__.ts.template

@@ -0,0 +1,3 @@
+export function <%= projectNameCamelCase %>(): string {
+  return '<%= projectName %>';
+}

package/templates/kos-model-project/project/tsconfig.json.template

@@ -0,0 +1,20 @@
+{
+  "extends": "<%= offsetFromRoot %>tsconfig.base.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "importHelpers": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    }
+  ]
+}

package/templates/kos-model-project/project/tsconfig.lib.json.template

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "<%= offsetFromRoot %>dist/out-tsc",
+    "declaration": true,
+    "types": ["node", "vite/client"],
+    "module": "esnext"
+  },
+  "include": ["src/**/*.ts"]
+}

package/templates/kos-model-project/project/vite.config.ts.template

@@ -0,0 +1,47 @@
+/// <reference types='vitest' />
+import { defineConfig } from 'vite';
+import dts from 'vite-plugin-dts';
+import * as path from 'path';
+import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
+import { nxCopyAssetsPlugin } from '@nx/vite/plugins/nx-copy-assets.plugin';
+
+export default defineConfig(() => ({
+  root: __dirname,
+  cacheDir: '<%= offsetFromRoot %>node_modules/.vite/<%= projectRoot %>',
+  plugins: [
+    nxViteTsPaths(),
+    nxCopyAssetsPlugin(['*.md']),
+    dts({
+      entryRoot: 'src',
+      tsconfigPath: path.join(__dirname, 'tsconfig.lib.json'),
+      pathsToAliases: false,
+    }),
+  ],
+  // Uncomment this if you are using workers.
+  // worker: {
+  //  plugins: [ nxViteTsPaths() ],
+  // },
+  // Configuration for building your library.
+  // See: https://vitejs.dev/guide/build.html#library-mode
+  build: {
+    outDir: '<%= offsetFromRoot %>dist/<%= projectRoot %>',
+    emptyOutDir: true,
+    reportCompressedSize: true,
+    commonjsOptions: {
+      transformMixedEsModules: true,
+    },
+    lib: {
+      // Could also be a dictionary or array of multiple entry points.
+      entry: 'src/index.ts',
+      name: '<%= projectName %>',
+      fileName: 'index',
+      // Change this to the formats you want to support.
+      // Don't forget to update your package.json as well.
+      formats: ['es' as const],
+    },
+    rollupOptions: {
+      // External packages that should not be bundled into your library.
+      external: [],
+    },
+  },
+}));

package/templates/kos-view-model/__nameDashCase__-view-model.ts.template

@@ -0,0 +1,30 @@
+/**
+ * UI-only state for the <%= nameProperCase %> view, held <% if (constructorParams.length) { %>beside the KOS data models it
+ * reads rather than inside them<% } else { %>outside the KOS data models<% } %>. A ViewModel is not registered and is
+ * not part of the model graph; create one per component with
+ * `useViewModel(() => new <%= nameProperCase %>ViewModel(<%= constructorArgs %>))`.
+ */
+<% if (internal) { %>import {
+  kosViewModel,
+  kosLoggerAware,
+  type KosViewModelLoggerAware,
+} from "../../../core/core/decorators";
+<% } else { %>import {
+  kosViewModel,
+  kosLoggerAware,
+  type KosViewModelLoggerAware,
+} from "@kosdev-code/kos-ui-sdk";
+<% } %><% modelImports.forEach(function (imp) { %>import type { <%= imp.types.join(", ") %> } from "<%= imp.module %>";
+<% }); %>
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
+export interface <%= nameProperCase %>ViewModel extends KosViewModelLoggerAware {}
+
+@kosViewModel({ typeId: "<%= typeId %>"<% if (devToolsEnabled) { %>, devToolsEnabled: true<% } %> })
+@kosLoggerAware()
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
+export class <%= nameProperCase %>ViewModel {
+<% if (constructorParams.length === 0) { %>  constructor() {}
+<% } else { %>  constructor(
+<% constructorParams.forEach(function (param, index) { %>    private readonly <%= param.name %>: <%= param.type %><% if (index < constructorParams.length - 1) { %>,<% } %>
+<% }); %>  ) {}
+<% } %>}

package/templates/kos-view-model/index.ts.template

@@ -0,0 +1 @@
+export { <%= nameProperCase %>ViewModel } from "./<%= nameDashCase %>-view-model";