@ts-ioc-container/bundler 1.5.0 → 2.1.0

package/cjm/modules/CommonModule.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommonModule = void 0;
+const ts_ioc_container_1 = require("ts-ioc-container");
+const CliIo_1 = require("../domain/CliIo");
+const GlobalConfig_1 = require("../domain/GlobalConfig");
+const ExceptionHandler_1 = require("../exceptions/ExceptionHandler");
+const ConsoleLogger_1 = require("../services/ConsoleLogger");
+const HandlebarsRenderService_1 = require("../services/HandlebarsRenderService");
+const NodeFileSystemService_1 = require("../services/NodeFileSystemService");
+const OutputService_1 = require("../services/OutputService");
+class CommonModule {
+    io;
+    constructor(io) {
+        this.io = io;
+    }
+    applyTo(container) {
+        container
+            .addRegistration(ts_ioc_container_1.Registration.fromValue(this.io).bindTo(CliIo_1.CliIoKey))
+            .addRegistration(ts_ioc_container_1.Registration.fromValue({ cwd: this.io.cwd }).bindTo(GlobalConfig_1.GlobalConfigKey))
+            .addRegistration(ts_ioc_container_1.Registration.fromClass(OutputService_1.StdOutputService))
+            .addRegistration(ts_ioc_container_1.Registration.fromClass(ConsoleLogger_1.ConsoleLogger))
+            .addRegistration(ts_ioc_container_1.Registration.fromClass(ExceptionHandler_1.ExceptionHandler))
+            .addRegistration(ts_ioc_container_1.Registration.fromClass(NodeFileSystemService_1.NodeFileSystemService))
+            .addRegistration(ts_ioc_container_1.Registration.fromClass(HandlebarsRenderService_1.HandlebarsRenderService));
+    }
+}
+exports.CommonModule = CommonModule;

package/cjm/schema/ticConfigSchema.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ticConfigJsonSchema = ticConfigJsonSchema;
+const zod_1 = require("zod");
+const BuildConfig_1 = require("../features/build/BuildConfig");
+function ticConfigJsonSchema() {
+    const schema = zod_1.z.toJSONSchema(BuildConfig_1.BUNDLE_CONFIG_SCHEMA, {
+        io: 'input',
+        target: 'draft-7',
+        unrepresentable: 'any',
+        override: ({ jsonSchema }) => {
+            if (jsonSchema.type === 'object')
+                jsonSchema.additionalProperties = false;
+        },
+    });
+    const { $schema, ...rest } = schema;
+    return {
+        $schema,
+        $id: 'https://github.com/IgorBabkin/ts-ioc-container/tree/main/packages/bundler/tic.schema.json',
+        title: '*.bundle.json / *.bundle.yaml',
+        description: "One bundle generated by `tic build` (@ts-ioc-container/bundler). `tic build` builds every `*.bundle.json` / `*.bundle.yaml` / `*.bundle.yml` at the root of the package it is invoked in, or — with none — one bundle from that package's tsconfig.json with every setting at its default. Relative paths resolve against this file's directory.",
+        ...rest,
+    };
+}

package/cjm/services/ConsoleLogger.js

@@ -0,0 +1,36 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsoleLogger = exports.ILoggerKey = void 0;
+const ts_ioc_container_1 = require("ts-ioc-container");
+const CliIo_1 = require("../domain/CliIo");
+exports.ILoggerKey = new ts_ioc_container_1.SingleToken('ILogger');
+let ConsoleLogger = class ConsoleLogger {
+    io;
+    constructor(io) {
+        this.io = io;
+    }
+    warn(message) {
+        this.io.stderr(`tic: warning: ${message}`);
+    }
+    error(message) {
+        this.io.stderr(`tic: ${message}`);
+    }
+};
+exports.ConsoleLogger = ConsoleLogger;
+exports.ConsoleLogger = ConsoleLogger = __decorate([
+    (0, ts_ioc_container_1.register)(exports.ILoggerKey),
+    __param(0, (0, ts_ioc_container_1.inject)((0, ts_ioc_container_1.by)(CliIo_1.CliIoKey))),
+    __metadata("design:paramtypes", [Object])
+], ConsoleLogger);

package/cjm/services/HandlebarsRenderService.js

@@ -0,0 +1,33 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HandlebarsRenderService = exports.IRenderServiceKey = void 0;
+exports.renderProtocol = renderProtocol;
+require("../../tpl/index.cjs");
+const handlebars_1 = __importDefault(require("handlebars"));
+const ts_ioc_container_1 = require("ts-ioc-container");
+handlebars_1.default.registerHelper('join', (items, separator) => items.join(separator));
+function renderProtocol(name, data) {
+    const protocol = handlebars_1.default.templates?.[name];
+    if (!protocol)
+        throw new Error(`Protocol not found: ${name}`);
+    return protocol(data);
+}
+exports.IRenderServiceKey = new ts_ioc_container_1.SingleToken('IRenderService');
+let HandlebarsRenderService = class HandlebarsRenderService {
+    render(protocol, data) {
+        return renderProtocol(protocol, data);
+    }
+};
+exports.HandlebarsRenderService = HandlebarsRenderService;
+exports.HandlebarsRenderService = HandlebarsRenderService = __decorate([
+    (0, ts_ioc_container_1.register)(exports.IRenderServiceKey)
+], HandlebarsRenderService);

package/cjm/services/NodeFileSystemService.js

@@ -0,0 +1,32 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeFileSystemService = exports.IFileSystemServiceKey = void 0;
+const node_fs_1 = require("node:fs");
+const node_path_1 = __importDefault(require("node:path"));
+const ts_ioc_container_1 = require("ts-ioc-container");
+exports.IFileSystemServiceKey = new ts_ioc_container_1.SingleToken('IFileSystemService');
+let NodeFileSystemService = class NodeFileSystemService {
+    fileExists(file) {
+        return (0, node_fs_1.existsSync)(file);
+    }
+    readFile(file) {
+        return (0, node_fs_1.readFileSync)(file, 'utf8');
+    }
+    writeFile(file, content) {
+        (0, node_fs_1.mkdirSync)(node_path_1.default.dirname(file), { recursive: true });
+        (0, node_fs_1.writeFileSync)(file, content);
+    }
+};
+exports.NodeFileSystemService = NodeFileSystemService;
+exports.NodeFileSystemService = NodeFileSystemService = __decorate([
+    (0, ts_ioc_container_1.register)(exports.IFileSystemServiceKey)
+], NodeFileSystemService);

package/cjm/services/OutputService.js

@@ -0,0 +1,33 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StdOutputService = exports.IOutputServiceKey = void 0;
+const ts_ioc_container_1 = require("ts-ioc-container");
+const CliIo_1 = require("../domain/CliIo");
+exports.IOutputServiceKey = new ts_ioc_container_1.SingleToken('IOutputService');
+let StdOutputService = class StdOutputService {
+    io;
+    constructor(io) {
+        this.io = io;
+    }
+    write(line) {
+        this.io.stdout(line);
+    }
+};
+exports.StdOutputService = StdOutputService;
+exports.StdOutputService = StdOutputService = __decorate([
+    (0, ts_ioc_container_1.register)(exports.IOutputServiceKey),
+    __param(0, (0, ts_ioc_container_1.inject)((0, ts_ioc_container_1.by)(CliIo_1.CliIoKey))),
+    __metadata("design:paramtypes", [Object])
+], StdOutputService);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-ioc-container/bundler",
-  "version": "1.5.0",
+  "version": "2.1.0",
   "description": "Bundles your dependencies into a single container module for ts-ioc-container: the `tic` CLI scans folders (by path or tsconfig alias) and generates one typed bundle that registers every class — `container.useModule(new AppBundle())`.",
   "publishConfig": {
     "access": "public",
@@ -9,7 +9,6 @@
   "author": "ibabkin <igba14@gmail.com>",
   "homepage": "https://github.com/IgorBabkin/ts-ioc-container/tree/main/packages/bundler#readme",
   "license": "ISC",
-  "sideEffects": false,
   "main": "cjm/index.js",
   "types": "typings/index.d.ts",
   "bin": {
@@ -49,7 +48,11 @@
     "directory": "packages/bundler"
   },
   "dependencies": {
-    "handlebars": "^4.7.9"
+    "handlebars": "^4.7.9",
+    "reflect-metadata": "^0.2.2",
+    "yaml": "^2.8.3",
+    "zod": "^4.6.5",
+    "ts-ioc-container": "74.0.0"
   },
   "peerDependencies": {
     "typescript": ">=5"
@@ -57,11 +60,10 @@
   "devDependencies": {
     "@types/node": "^25.5.2",
     "@vitest/coverage-v8": "^4.1.2",
-    "reflect-metadata": "^0.2.2",
+    "moq.ts": "^10.0.8",
     "typescript": "5.8.3",
     "unplugin-swc": "^1.6.0",
-    "vitest": "^4.1.11",
-    "ts-ioc-container": "73.1.0"
+    "vitest": "^4.1.11"
   },
   "engines": {
     "node": ">= 18"
@@ -77,6 +79,7 @@
     "lint": "eslint lib/**/*.ts __tests__/**/*.ts",
     "lint:fix": "pnpm run lint --fix",
     "format": "prettier --write \"lib/**/*.ts\" \"__tests__/**/*.ts\"",
-    "format:check": "prettier --check \"lib/**/*.ts\" \"__tests__/**/*.ts\""
+    "format:check": "prettier --check \"lib/**/*.ts\" \"__tests__/**/*.ts\"",
+    "generate:schema": "pnpm run build:cjm && node scripts/generate-schema.cjs"
   }
 }

package/tic.schema.json

@@ -1,172 +1,143 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://github.com/IgorBabkin/ts-ioc-container/tree/main/packages/bundler/tic.schema.json",
-  "title": "tic.config.json",
-  "description": "Bundles generated by `tic build` (@ts-ioc-container/bundler). Relative paths resolve against this file's directory.",
+  "title": "*.bundle.json / *.bundle.yaml",
+  "description": "One bundle generated by `tic build` (@ts-ioc-container/bundler). `tic build` builds every `*.bundle.json` / `*.bundle.yaml` / `*.bundle.yml` at the root of the package it is invoked in, or — with none — one bundle from that package's tsconfig.json with every setting at its default. Relative paths resolve against this file's directory.",
   "type": "object",
-  "required": [
-    "bundles"
-  ],
-  "additionalProperties": false,
   "properties": {
     "$schema": {
       "type": "string"
     },
-    "tsconfig": {
+    "output": {
+      "description": "The bundle file (convention: *.bundle.ts). Default `<root>/<name>.bundle.ts`: <root> is the tsconfig's rootDir, else the common folder of the files it compiles. Required when there is no tsconfig to extend.",
       "type": "string",
-      "description": "tsconfig whose `paths` aliases namespaces and imports may use. Default `tsconfig.json`, which may be absent."
+      "minLength": 1
     },
-    "importExtension": {
+    "name": {
+      "description": "The bundle's name: letters, digits, \"-\" and \"_\", starting with a letter. Default: this file's stem (production.bundle.json → production), else \"base\". It names the default output (production.bundle.ts) and the generated IContainerModule class (ProductionBundle).",
       "type": "string",
-      "description": "Extension of generated imports, e.g. \".js\". Inferred from the tsconfig: \".js\" under node16/nodenext resolution, none otherwise."
+      "pattern": "^[A-Za-z][\\w-]*$"
     },
-    "bundles": {
+    "tags": {
+      "default": [],
+      "description": "Tags associated with the bundle.",
       "type": "array",
-      "minItems": 1,
       "items": {
-        "type": "object",
-        "required": [
-          "output",
-          "namespaces"
-        ],
-        "additionalProperties": false,
-        "properties": {
-          "output": {
-            "type": "string",
-            "minLength": 1,
-            "description": "The bundle file (convention: *.bundle.ts)."
-          },
-          "name": {
-            "type": "string",
-            "pattern": "^[A-Za-z_$][\\w$]*$",
-            "default": "Bundle",
-            "description": "Name of the generated class, an IContainerModule."
-          },
-          "tags": {
-            "type": "array",
-            "items": {
-              "type": "string",
-              "minLength": 1
-            },
-            "description": "Tags associated with the bundle."
-          },
-          "namespaces": {
-            "type": "array",
-            "minItems": 1,
-            "description": "Folders to scan: paths relative to this file (./src/services) or tsconfig paths aliases (@app/services).",
-            "items": {
-              "oneOf": [
-                {
-                  "type": "string",
-                  "minLength": 1
-                },
-                {
-                  "type": "object",
-                  "required": [
-                    "path"
-                  ],
-                  "additionalProperties": false,
-                  "properties": {
-                    "path": {
-                      "type": "string",
-                      "minLength": 1
-                    },
-                    "recursive": {
-                      "type": "boolean",
-                      "default": true
-                    }
-                  }
-                }
-              ]
-            }
-          },
-          "select": {
-            "type": "object",
-            "additionalProperties": false,
-            "description": "How target classes are picked out of a file. A class is selected when it is exported, not abstract, and meets every criterion set here; omit it to register every exported class.",
-            "properties": {
-              "export": {
-                "enum": [
-                  "any",
-                  "named",
-                  "default"
-                ],
-                "default": "any",
-                "description": "Which exports count."
-              },
-              "decorators": {
-                "type": "array",
-                "minItems": 1,
-                "items": {
-                  "type": "string",
-                  "minLength": 1
-                },
-                "description": "The class must carry one of these decorators, recognised by name (e.g. \"register\", or a composed decorator)."
-              },
-              "nameGlob": {
-                "type": "string",
-                "minLength": 1,
-                "description": "Glob the class name must match, e.g. \"*Service\". An anonymous default export is named after its file."
-              },
-              "excludeClasses": {
-                "type": "array",
-                "minItems": 1,
-                "items": {
-                  "type": "string",
-                  "minLength": 1
-                },
-                "description": "Class names to drop after selection, e.g. one test double sitting next to the real registration in the same file."
-              },
-              "excludeNameGlob": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "extends": {
+      "default": "./tsconfig.json",
+      "description": "The tsconfig this bundle builds on, like a tsconfig's own `extends`: what it compiles (`files` / `include` / `exclude`) is the bundle's file set unless `files.paths` overrides it, and its `paths` aliases and module resolution shape the generated imports. Relative to this file. The default may be absent; a tsconfig named here must exist.",
+      "type": "string",
+      "minLength": 1
+    },
+    "importExtension": {
+      "description": "Extension of generated imports, e.g. \".js\". Inferred from the tsconfig: \".js\" under node16/nodenext resolution, none otherwise.",
+      "type": "string"
+    },
+    "files": {
+      "type": "object",
+      "properties": {
+        "paths": {
+          "description": "Folders to scan instead of the extended tsconfig's file set: paths relative to this file (./src/services) or tsconfig paths aliases (@app/services). Required when there is no tsconfig to extend.",
+          "minItems": 1,
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
                 "type": "string",
-                "minLength": 1,
-                "description": "Glob the class name must NOT match, e.g. \"*Mock\". An anonymous default export is named after its file."
+                "minLength": 1
               },
-              "excludeAliases": {
-                "type": "array",
-                "minItems": 1,
-                "items": {
-                  "type": "string",
-                  "minLength": 1
+              {
+                "type": "object",
+                "properties": {
+                  "path": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "recursive": {
+                    "default": true,
+                    "type": "boolean"
+                  }
                 },
-                "description": "tsconfig paths aliases to drop after selection, e.g. [\"services\"] for a `services/*` (or `@services/*`) alias. A class whose file resolves through one of these aliases is dropped. Names may omit a leading `@` and a trailing `/*`."
+                "required": ["path"],
+                "additionalProperties": false
               }
-            }
-          },
-          "exclude": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            },
-            "default": [
-              "**/*.spec.ts",
-              "**/*.test.ts",
-              "**/*.spec.tsx",
-              "**/*.test.tsx",
-              "**/__tests__/**",
-              "**/node_modules/**"
-            ],
-            "description": "Globs, relative to this file, of files never scanned. Replaces the default when given; prefer additionalExclude to add one exclusion without restating the defaults. A non-empty list that omits a default glob makes `tic build` warn."
-          },
-          "additionalExclude": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            },
-            "description": "Globs, relative to this file, of files never scanned, added on top of `exclude` (or the default excludes when `exclude` is omitted)."
-          },
-          "include": {
+            ]
+          }
+        },
+        "include": {
+          "description": "Globs a file must match one of, e.g. [\"**/*.service.ts\", \"**/*.repository.ts\"]. Default: every source file.",
+          "type": "array",
+          "items": {
             "type": "string",
-            "minLength": 1,
-            "description": "A file exporting an InclusionPredicate ((context: { filename }) => boolean), relative to this file. Overrides the conventional tic.include.* next to this file. A file takes part only when it matches no `exclude` glob and the predicate returns true."
+            "minLength": 1
           },
-          "filterExports": {
+          "minItems": 1
+        },
+        "exclude": {
+          "default": [
+            "**/*.spec.ts",
+            "**/*.test.ts",
+            "**/*.spec.tsx",
+            "**/*.test.tsx",
+            "**/__tests__/**",
+            "**/node_modules/**"
+          ],
+          "description": "Globs of files never read. Replaces the default when given. A non-empty list that omits a default glob makes `tic build` warn.",
+          "type": "array",
+          "items": {
             "type": "string",
-            "minLength": 1,
-            "description": "A file exporting an ExportPredicate ((context: { filename, exportName, className, isDefault, decorators, tags }) => boolean), relative to this file. Runs on every exported, non-abstract class that passes `select`, right after parsing. Overrides the conventional tic.exports.* next to this file."
+            "minLength": 1
           }
         }
-      }
+      },
+      "additionalProperties": false,
+      "description": "Which files this bundle reads and parses — decided by path alone, before parsing. The candidates are what the extended tsconfig compiles, or the folders in `paths` when given. A candidate is parsed when it matches one of `include` and none of `exclude`. Globs are relative to this file. With a file naming convention, `include` keeps every other file unread."
+    },
+    "classes": {
+      "type": "object",
+      "properties": {
+        "export": {
+          "default": "any",
+          "description": "Which exports count.",
+          "type": "string",
+          "enum": ["any", "named", "default"]
+        },
+        "decorators": {
+          "default": ["register"],
+          "description": "The class must carry one of these decorators, recognised by name (e.g. \"register\", or a composed decorator). Default [\"register\"]; [] requires none.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "name": {
+          "description": "Glob the class name must match, e.g. \"*Service\". An anonymous default export is named after its file.",
+          "type": "string",
+          "minLength": 1
+        },
+        "excludeClasses": {
+          "description": "Class names to drop after selection, e.g. one test double sitting next to the real registration in the same file.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "minItems": 1
+        },
+        "excludeName": {
+          "description": "Glob the class name must NOT match, e.g. \"*Mock\". An anonymous default export is named after its file.",
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": false,
+      "description": "Which classes of a parsed file are registered. A class is selected when it is exported, not abstract, and meets every criterion set here; by default that is every exported class decorated with @register."
     }
-  }
+  },
+  "additionalProperties": false
 }