@elliots/typical-compiler 0.2.3 → 0.2.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Elliot Shepherd
+
+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/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { ProjectHandle, TransformResult } from './types.js';
+import type { ProjectHandle, TransformResult, AnalyseResult } from './types.js';
 export interface TypicalCompilerOptions {
     /** Path to the typical binary. If not provided, uses the bundled binary. */
     binaryPath?: string;
@@ -16,8 +16,20 @@ export declare class TypicalCompiler {
     start(): Promise<void>;
     close(): Promise<void>;
     loadProject(configFileName: string): Promise<ProjectHandle>;
-    transformFile(project: ProjectHandle | string, fileName: string, ignoreTypes?: string[], maxGeneratedFunctions?: number, reusableValidators?: 'auto' | 'never' | 'always'): Promise<TransformResult>;
+    transformFile(project: ProjectHandle | string, fileName: string, ignoreTypes?: string[], maxGeneratedFunctions?: number): Promise<TransformResult>;
     release(handle: ProjectHandle | string): Promise<void>;
+    /**
+     * Analyse a file for validation points without transforming it.
+     * Returns information about which parameters, returns, and casts will be validated.
+     * Used by the VSCode extension to show validation indicators.
+     *
+     * @param project - Project handle or ID
+     * @param fileName - Path to the file to analyse
+     * @param content - Optional file content for live updates (uses disk version if not provided)
+     * @param ignoreTypes - Optional glob patterns for types to skip
+     * @returns Analysis result with validation items
+     */
+    analyseFile(project: ProjectHandle | string, fileName: string, content?: string, ignoreTypes?: string[]): Promise<AnalyseResult>;
     /**
      * Transform a standalone TypeScript source string.
      * Creates a temporary project to enable type checking.
@@ -30,7 +42,6 @@ export declare class TypicalCompiler {
     transformSource(fileName: string, source: string, options?: {
         ignoreTypes?: string[];
         maxGeneratedFunctions?: number;
-        reusableValidators?: 'auto' | 'never' | 'always';
     }): Promise<TransformResult>;
     private request;
     private handleData;

package/dist/client.js

@@ -3,6 +3,7 @@ import { join, dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { createRequire } from 'node:module';
 import { encodeRequest, decodeResponse } from './protocol.js';
+import { existsSync } from 'node:fs';
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const require = createRequire(import.meta.url);
 const debug = process.env.DEBUG === '1';
@@ -12,17 +13,13 @@ function debugLog(...args) {
     }
 }
 function getBinaryPath() {
-    // try local binary first (for development)
-    const localBinPath = join(__dirname, '..', 'bin', 'typical');
-    try {
-        require('fs').accessSync(localBinPath);
-        debugLog(`[CLIENT] Using local binary at ${localBinPath}`);
-        return localBinPath;
+    // use bin/typical in development
+    const devPath = join(__dirname, '../bin/typical');
+    if (existsSync(devPath)) {
+        debugLog(`[CLIENT] Using development binary at ${devPath}`);
+        return devPath;
     }
-    catch {
-        // continue to platform-specific package
-    }
-    // Then use platform-specific package
+    // Find platform-specific package
     const platform = process.platform; // darwin, linux, win32
     const arch = process.arch; // arm64, x64
     const pkgName = `@elliots/typical-compiler-${platform}-${arch}`;
@@ -83,20 +80,39 @@ export class TypicalCompiler {
     async loadProject(configFileName) {
         return this.request('loadProject', { configFileName });
     }
-    async transformFile(project, fileName, ignoreTypes, maxGeneratedFunctions, reusableValidators) {
+    async transformFile(project, fileName, ignoreTypes, maxGeneratedFunctions) {
         const projectId = typeof project === 'string' ? project : project.id;
         return this.request('transformFile', {
             project: projectId,
             fileName,
             ignoreTypes,
             maxGeneratedFunctions,
-            reusableValidators,
         });
     }
     async release(handle) {
         const id = typeof handle === 'string' ? handle : handle.id;
         await this.request('release', id);
     }
+    /**
+     * Analyse a file for validation points without transforming it.
+     * Returns information about which parameters, returns, and casts will be validated.
+     * Used by the VSCode extension to show validation indicators.
+     *
+     * @param project - Project handle or ID
+     * @param fileName - Path to the file to analyse
+     * @param content - Optional file content for live updates (uses disk version if not provided)
+     * @param ignoreTypes - Optional glob patterns for types to skip
+     * @returns Analysis result with validation items
+     */
+    async analyseFile(project, fileName, content, ignoreTypes) {
+        const projectId = typeof project === 'string' ? project : project.id;
+        return this.request('analyseFile', {
+            project: projectId,
+            fileName,
+            content,
+            ignoreTypes,
+        });
+    }
     /**
      * Transform a standalone TypeScript source string.
      * Creates a temporary project to enable type checking.
@@ -112,7 +128,6 @@ export class TypicalCompiler {
             source,
             ignoreTypes: options?.ignoreTypes,
             maxGeneratedFunctions: options?.maxGeneratedFunctions,
-            reusableValidators: options?.reusableValidators,
         });
     }
     async request(method, payload) {

package/dist/types.d.ts

@@ -16,3 +16,27 @@ export interface TransformResult {
     code: string;
     sourceMap?: RawSourceMap;
 }
+/** Represents a single validation point in the source code */
+export interface ValidationItem {
+    /** 1-based line number */
+    startLine: number;
+    /** 0-based column */
+    startColumn: number;
+    /** 1-based line number */
+    endLine: number;
+    /** 0-based column */
+    endColumn: number;
+    /** Type of validation: "parameter", "return", "cast", "json-parse", "json-stringify" */
+    kind: 'parameter' | 'return' | 'cast' | 'json-parse' | 'json-stringify';
+    /** Name of the item being validated (param name, "return value", or expression text) */
+    name: string;
+    /** Whether the item will be validated or skipped */
+    status: 'validated' | 'skipped';
+    /** Human-readable type string */
+    typeString: string;
+    /** Reason for skipping (when status is "skipped") */
+    skipReason?: string;
+}
+export interface AnalyseResult {
+    items: ValidationItem[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliots/typical-compiler",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "TypeScript compiler powered by tsgo for typical validation",
   "keywords": [
     "compiler",
@@ -26,16 +26,16 @@
     "typescript": "^5.7.0"
   },
   "optionalDependencies": {
-    "@elliots/typical-compiler-darwin-arm64": "0.2.3",
-    "@elliots/typical-compiler-darwin-x64": "0.2.3",
-    "@elliots/typical-compiler-linux-arm64": "0.2.3",
-    "@elliots/typical-compiler-linux-x64": "0.2.3",
-    "@elliots/typical-compiler-win32-arm64": "0.2.3",
-    "@elliots/typical-compiler-win32-x64": "0.2.3"
+    "@elliots/typical-compiler-darwin-arm64": "0.2.4",
+    "@elliots/typical-compiler-darwin-x64": "0.2.4",
+    "@elliots/typical-compiler-linux-arm64": "0.2.4",
+    "@elliots/typical-compiler-linux-x64": "0.2.4",
+    "@elliots/typical-compiler-win32-arm64": "0.2.4",
+    "@elliots/typical-compiler-win32-x64": "0.2.4"
   },
   "scripts": {
-    "build": "tsc",
-    "build:go": "./go/scripts/sync-shims.sh && cd go && go build -o ../bin/typical ./cmd/typical",
-    "test": "npx tsx test/e2e.ts"
+    "build": "npm run build:ts && npm run build:go",
+    "build:ts": "tsc",
+    "build:go": "./go/scripts/sync-shims.sh && cd go && go build -o ../bin/typical ./cmd/typical"
   }
 }