boperators 0.1.0

package/dist/esm/core/validateExports.js

@@ -0,0 +1,84 @@
+import { Node } from "ts-morph";
+/**
+ * Validate that all classes with registered operator overloads are exported
+ * and (optionally) reachable from a package entry point.
+ *
+ * @param project     The ts-morph project containing the source files.
+ * @param overloadStore  Populated OverloadStore for the project.
+ * @param projectDir  Absolute path to the project root — used to filter out
+ *                    overloads sourced from library dependencies.
+ * @param entryPoint  Absolute path to the source entry point (e.g. `src/index.ts`).
+ *                    When provided, a second pass checks that every overload
+ *                    class is transitively reachable from this file via its
+ *                    export graph. Omit to run the file-level check only.
+ */
+export function validateExports({ project, overloadStore, projectDir, entryPoint, }) {
+    var _a;
+    const violations = [];
+    const normalizedDir = projectDir.replace(/\\/g, "/").replace(/\/$/, "");
+    // Deduplicate: collect unique (className, classFilePath) pairs whose
+    // source lives inside this project (skip .d.ts from dependencies).
+    const seen = new Set();
+    const classes = [];
+    for (const overload of overloadStore.getAllOverloads()) {
+        const normalized = overload.classFilePath.replace(/\\/g, "/");
+        const inProject = normalized.startsWith(`${normalizedDir}/`) ||
+            normalized === normalizedDir;
+        if (!inProject)
+            continue;
+        if (normalized.endsWith(".d.ts"))
+            continue;
+        const key = `${overload.className}::${normalized}`;
+        if (!seen.has(key)) {
+            seen.add(key);
+            classes.push({
+                className: overload.className,
+                classFilePath: overload.classFilePath,
+            });
+        }
+    }
+    // Level 2 setup: resolve the set of class declarations reachable from the
+    // entry point by walking the full export graph (follows re-exports).
+    let entryExportedClassDecls;
+    if (entryPoint) {
+        const entryFile = (_a = project.getSourceFile(entryPoint)) !== null && _a !== void 0 ? _a : project.addSourceFileAtPath(entryPoint);
+        entryExportedClassDecls = new Set();
+        for (const decls of entryFile.getExportedDeclarations().values()) {
+            for (const decl of decls) {
+                if (Node.isClassDeclaration(decl)) {
+                    entryExportedClassDecls.add(decl);
+                }
+            }
+        }
+    }
+    // Check each class.
+    for (const { className, classFilePath } of classes) {
+        const sourceFile = project.getSourceFile(classFilePath);
+        if (!sourceFile)
+            continue;
+        const classDecl = sourceFile.getClass(className);
+        if (!classDecl)
+            continue;
+        // Level 1: is the class exported from its own source file?
+        if (!classDecl.isExported()) {
+            violations.push({
+                className,
+                classFilePath,
+                reason: "not-exported-from-file",
+            });
+            // If not exported from file it cannot be in the entry point graph
+            // either — no need to run the deep check for this class.
+            continue;
+        }
+        // Level 2: is the class reachable from the entry point?
+        if (entryExportedClassDecls !== undefined &&
+            !entryExportedClassDecls.has(classDecl)) {
+            violations.push({
+                className,
+                classFilePath,
+                reason: "not-reachable-from-entry",
+            });
+        }
+    }
+    return { violations };
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,19 @@
+export type { BopConfFile, BopConfig, BopLogger, LoadConfigOptions, LogLevel, } from "./core/BopConfig";
+export { ConsoleLogger, loadConfig } from "./core/BopConfig";
+export { ErrorDescription, ErrorManager } from "./core/ErrorManager";
+export { getOperatorStringFromProperty } from "./core/helpers/getOperatorStringFromProperty";
+export { resolveExpressionType } from "./core/helpers/resolveExpressionType";
+export { unwrapInitializer } from "./core/helpers/unwrapInitializer";
+export type { TransformResult } from "./core/OverloadInjector";
+export { OverloadInjector } from "./core/OverloadInjector";
+export type { OverloadDescription, OverloadInfo } from "./core/OverloadStore";
+export { OverloadStore } from "./core/OverloadStore";
+export type { OperatorSyntaxKind, PostfixUnaryOperatorSyntaxKind, PrefixUnaryOperatorSyntaxKind, } from "./core/operatorMap";
+export { isOperatorSyntaxKind, isPostfixUnaryOperatorSyntaxKind, isPrefixUnaryOperatorSyntaxKind, } from "./core/operatorMap";
+export type { EditRecord } from "./core/SourceMap";
+export { SourceMap } from "./core/SourceMap";
+export type { ExportViolation, ExportViolationReason, ValidateExportsResult, } from "./core/validateExports";
+export { validateExports } from "./core/validateExports";
+export { Operator, operatorSymbols } from "./lib/operatorSymbols";
+export type { SourceFile } from "ts-morph";
+export { Node, Project, SyntaxKind } from "ts-morph";

package/dist/esm/index.js

@@ -0,0 +1,14 @@
+// Core transformation pipeline
+export { ConsoleLogger, loadConfig } from "./core/BopConfig";
+export { ErrorDescription, ErrorManager } from "./core/ErrorManager";
+export { getOperatorStringFromProperty } from "./core/helpers/getOperatorStringFromProperty";
+export { resolveExpressionType } from "./core/helpers/resolveExpressionType";
+export { unwrapInitializer } from "./core/helpers/unwrapInitializer";
+export { OverloadInjector } from "./core/OverloadInjector";
+export { OverloadStore } from "./core/OverloadStore";
+export { isOperatorSyntaxKind, isPostfixUnaryOperatorSyntaxKind, isPrefixUnaryOperatorSyntaxKind, } from "./core/operatorMap";
+export { SourceMap } from "./core/SourceMap";
+export { validateExports } from "./core/validateExports";
+// Operator definitions
+export { Operator, operatorSymbols } from "./lib/operatorSymbols";
+export { Node, Project, SyntaxKind } from "ts-morph";

package/dist/esm/lib/index.d.ts

@@ -0,0 +1 @@
+export * from "./operatorSymbols";

package/dist/esm/lib/index.js

@@ -0,0 +1 @@
+export * from "./operatorSymbols";

package/dist/esm/lib/operatorSymbols.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Designed for internal use to ensure consistency.
+ */
+export declare enum Operator {
+    PLUS = "+",
+    PLUS_EQUALS = "+=",
+    MINUS = "-",
+    MINUS_EQUALS = "-=",
+    MULTIPLY = "*",
+    MULTIPLY_EQUALS = "*=",
+    DIVIDE = "/",
+    DIVIDE_EQUALS = "/=",
+    GREATER_THAN = ">",
+    GREATER_THAN_EQUAL_TO = ">=",
+    LESS_THAN = "<",
+    LESS_THAN_EQUAL_TO = "<=",
+    MODULO = "%",
+    MODULO_EQUALS = "%=",
+    EQUALS = "==",
+    STRICT_EQUALS = "===",
+    NOT_EQUALS = "!=",
+    STRICT_NOT_EQUALS = "!==",
+    AND = "&&",
+    AND_EQUALS = "&&=",
+    OR = "||",
+    OR_EQUALS = "||=",
+    NULLISH = "??",
+    NOT = "!",
+    BITWISE_NOT = "~",
+    INCREMENT = "++",
+    DECREMENT = "--"
+}
+export declare const operatorSymbols: string[];

package/dist/esm/lib/operatorSymbols.js

@@ -0,0 +1,34 @@
+/**
+ * Designed for internal use to ensure consistency.
+ */
+export var Operator;
+(function (Operator) {
+    Operator["PLUS"] = "+";
+    Operator["PLUS_EQUALS"] = "+=";
+    Operator["MINUS"] = "-";
+    Operator["MINUS_EQUALS"] = "-=";
+    Operator["MULTIPLY"] = "*";
+    Operator["MULTIPLY_EQUALS"] = "*=";
+    Operator["DIVIDE"] = "/";
+    Operator["DIVIDE_EQUALS"] = "/=";
+    Operator["GREATER_THAN"] = ">";
+    Operator["GREATER_THAN_EQUAL_TO"] = ">=";
+    Operator["LESS_THAN"] = "<";
+    Operator["LESS_THAN_EQUAL_TO"] = "<=";
+    Operator["MODULO"] = "%";
+    Operator["MODULO_EQUALS"] = "%=";
+    Operator["EQUALS"] = "==";
+    Operator["STRICT_EQUALS"] = "===";
+    Operator["NOT_EQUALS"] = "!=";
+    Operator["STRICT_NOT_EQUALS"] = "!==";
+    Operator["AND"] = "&&";
+    Operator["AND_EQUALS"] = "&&=";
+    Operator["OR"] = "||";
+    Operator["OR_EQUALS"] = "||=";
+    Operator["NULLISH"] = "??";
+    Operator["NOT"] = "!";
+    Operator["BITWISE_NOT"] = "~";
+    Operator["INCREMENT"] = "++";
+    Operator["DECREMENT"] = "--";
+})(Operator || (Operator = {}));
+export const operatorSymbols = Object.values(Operator);

package/license.txt

@@ -0,0 +1,8 @@
+Copyright 2025 Dief Bell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/package.json

@@ -0,0 +1,54 @@
+{
+	"name": "boperators",
+	"version": "0.1.0",
+	"license": "MIT",
+	"description": "Operator overloading for TypeScript.",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/DiefBell/boperators",
+		"directory": "package"
+	},
+	"homepage": "https://github.com/DiefBell/boperators/tree/main/package",
+	"main": "./dist/cjs/index.js",
+	"module": "./dist/esm/index.js",
+	"types": "./dist/esm/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/esm/index.d.ts",
+			"require": "./dist/cjs/index.js",
+			"import": "./dist/esm/index.js"
+		}
+	},
+	"keywords": [
+		"boperators",
+		"typescript",
+		"operator",
+		"overload",
+		"operator-overloading",
+		"ts-morph",
+		"ast",
+		"transform"
+	],
+	"scripts": {
+		"build": "tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json",
+		"watch": "concurrently \"tsc -p tsconfig.cjs.json -w\" \"tsc -p tsconfig.esm.json -w\"",
+		"prepare": "bun run build",
+		"prepublish": "bun run build"
+	},
+	"dependencies": {
+		"ts-morph": "^27.0.0"
+	},
+	"peerDependencies": {
+		"typescript": ">=5.0.0 <5.10.0"
+	},
+	"files": [
+		"package.json",
+		"license.txt",
+		"README.md",
+		"dist"
+	],
+	"devDependencies": {
+		"@types/node": "^22.0.0",
+		"concurrently": "^9.2.1"
+	}
+}