@happyvertical/smrt-scanner 0.30.0

package/AGENTS.md

@@ -0,0 +1,69 @@
+# @happyvertical/smrt-scanner
+
+AST-based scanner for discovering SMRT objects in TypeScript source. Uses
+oxc-parser (Rust, 2-3x faster than tsc) for syntactic parsing — it never
+executes the source.
+
+## Key Exports
+
+- `OxcScanner` — class that globs `.ts` files (`fast-glob`) and parses each into
+  raw class/field/method metadata. `scan()` parses; `scanAndResolve()` parses
+  then resolves inheritance in one call.
+- `InheritanceResolver` — resolves class inheritance chains across files
+  (`addClasses()` → `resolveAll()`), merging inherited fields/config into each
+  `@smrt()` subclass.
+- `ManifestAdapter` — converts resolved classes into the SMRT manifest shape
+  (`toManifest()`); owns field-type inference (the `0` vs `0.0` integer/decimal
+  heuristic, decorator interpretation, union/alias resolution).
+- `parseFile` / `parseSource` — parse a single file or a source string to a
+  `FileScanResult` (classes, errors, type aliases, SMRT imports).
+- `extractSmrtImports` — pull SMRT-related imports from a parsed file.
+- `verifyManifestCompleteness({ packageDir })` — publish guard: re-scans `src/`
+  and asserts every `@smrt()` object reached `dist/manifest.json` (issue #1483).
+  Returns `ok` / `incomplete` / `missing-manifest` / `scan-error` / `skipped`.
+  Driven by `scripts/verify-manifest-completeness.mjs` from `prepack`.
+- Types (re-exported from `./types`): `RawClassDefinition`,
+  `RawFieldDefinition`, `RawMethodDefinition`, `ResolvedClassDefinition`,
+  `ScanResults`, `FileScanResult`, `OxcScannerOptions`, `InferredFieldType`,
+  `FieldTypeInference`.
+
+## How It Works
+
+1. `fast-glob` finds `.ts` files matching include/exclude patterns.
+2. `oxc-parser` parses each file's AST (TS-ESTree shape).
+3. Extracts: `@smrt()` config, class hierarchy, field defaults (0 vs 0.0
+   heuristic, including negative initializers via `UnaryExpression` unwrap),
+   relationships, static properties (`uiSlots`, `adminRoutes`).
+4. `InheritanceResolver` merges inherited members; `ManifestAdapter` emits the
+   manifest JSON consumed by code generators, the vitest plugin, and the CLI.
+
+## Key Files
+
+- `src/oxc-parser.ts` — core AST → raw metadata extraction (`parseFile`,
+  `parseSource`, `extractSmrtImports`, field/decorator/type extractors).
+- `src/scanner.ts` — `OxcScanner`: globbing + multi-file orchestration
+  (`scan` / `scanAndResolve`).
+- `src/inheritance-resolver.ts` — `InheritanceResolver`: cross-file inheritance
+  merging.
+- `src/manifest-adapter.ts` — `ManifestAdapter`: raw → manifest conversion and
+  field-type inference.
+- `src/verify-completeness.ts` — `verifyManifestCompleteness` publish guard.
+- `src/types.ts` — shared raw/resolved/result type definitions.
+- `src/cli.ts` / `bin/smrt-scan.js` — the `smrt-scan` CLI.
+
+## Gotchas
+
+- **Syntactic only**: the scanner parses, it does not type-check or execute.
+  Type aliases are resolved heuristically (bounded depth), not via the TS type
+  system.
+- **Build-time consumers**: `smrtVitestPlugin()` and the build's vite-plugin run
+  the scanner at startup; add a new `@smrt()` class → rebuild/restart so it
+  reaches the manifest.
+- **`ManifestBuilder` / `discoverBaseClasses` live in `@happyvertical/smrt-core`,
+  not here.** This package is the lower-level AST layer; core orchestrates
+  manifest generation and base-class discovery on top of it.
+- **0 vs 0.0 heuristic**: `count = 0` → integer, `price = 0.0` → decimal; the
+  raw initializer text (not the parsed value) decides, and negative defaults are
+  unwrapped from their `UnaryExpression` before the check.
+- **Static property capture**: captures `uiSlots` and `adminRoutes` for agent
+  manifest generation.

package/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright <2025> <Happy Vertical Corporation>
+
+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/README.md

@@ -0,0 +1,77 @@
+# @happyvertical/smrt-scanner
+
+High-performance TypeScript AST scanner using [OXC](https://oxc-project.github.io/) for SMRT manifest generation. Extracts class, field, method, and decorator metadata from source files without executing them.
+
+## Installation
+
+```bash
+pnpm add @happyvertical/smrt-scanner
+```
+
+## Usage
+
+```typescript
+import { OxcScanner, InheritanceResolver, ManifestAdapter } from '@happyvertical/smrt-scanner';
+import { parseFile, parseSource, extractSmrtImports } from '@happyvertical/smrt-scanner';
+
+// Scan a single file
+const result = parseFile('/path/to/Product.ts');
+// result.classes → RawClassDefinition[]
+// result.smrtImports → Map of SMRT package imports
+
+// Scan from source string
+const source = `
+  @smrt({ api: true })
+  class Product extends SmrtObject {
+    name: string = '';
+    price: number = 0.0;
+  }
+`;
+const parsed = parseSource(source, 'Product.ts');
+
+// Full scanner with glob support
+const scanner = new OxcScanner({ include: ['src/**/*.ts'] });
+const results = await scanner.scan();
+
+// Resolve inheritance across files
+const resolver = new InheritanceResolver();
+resolver.addClasses(results.classes);
+const resolved = resolver.resolveAll();
+
+// Convert to SMRT manifest format
+const adapter = new ManifestAdapter();
+const manifest = adapter.toManifest(resolved);
+```
+
+### CLI
+
+```bash
+# Scan and output manifest
+smrt-scan src/**/*.ts
+```
+
+## API
+
+### Classes
+
+| Export | Description |
+|--------|------------|
+| `OxcScanner` | Scans TypeScript files for `@smrt()` decorated classes |
+| `InheritanceResolver` | Resolves class inheritance chains across files |
+| `ManifestAdapter` | Converts raw scan results to SMRT manifest format |
+
+### Functions
+
+| Export | Description |
+|--------|------------|
+| `parseFile` | Parse a single TypeScript file and extract metadata |
+| `parseSource` | Parse a TypeScript source string |
+| `extractSmrtImports` | Extract SMRT-related imports from a file |
+
+### Key Types
+
+`RawClassDefinition`, `RawFieldDefinition`, `RawMethodDefinition`, `RawDecoratorConfig`, `ResolvedClassDefinition`, `ScanResults`, `FileScanResult`, `OxcScannerOptions`, `InferredFieldType`, `FieldTypeInference`
+
+## Dependencies
+
+- Peer (optional): `@happyvertical/smrt-core`

package/bin/smrt-scan.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..');
+const distEntry = resolve(packageRoot, 'dist/cli.js');
+const sourceEntry = resolve(packageRoot, 'src/cli.ts');
+
+const command = existsSync(distEntry)
+  ? [distEntry, ...process.argv.slice(2)]
+  : ['--import', 'tsx', sourceEntry, ...process.argv.slice(2)];
+
+const result = spawnSync(process.execPath, command, { stdio: 'inherit' });
+
+if (result.error) {
+  throw result.error;
+}
+
+if (result.signal) {
+  process.kill(process.pid, result.signal);
+}
+
+process.exit(result.status ?? 1);