@vercube/scan 1.2.0 → 1.2.2

package/dist/index.d.mts

@@ -11,7 +11,7 @@
  * @param node - An AST node from the program body to inspect.
  * @returns An object containing the class AST node and whether it is a default export, or `null` if not a class.
  */
-declare function getClassNode(node: any): {
+export declare function getClassNode(node: any): {
   classNode: any;
   isDefault: boolean;
 } | null;
@@ -23,7 +23,7 @@ declare function getClassNode(node: any): {
  * @param isDefault - Whether the class is a default export.
  * @returns The generated import statement string.
  */
-declare function buildImport(className: string, source: string, isDefault: boolean): string;
+export declare function buildImport(className: string, source: string, isDefault: boolean): string;
 /**
  * Searches a list of decorators for a `CallExpression` matching the given name
  * and extracts its first string argument.
@@ -36,7 +36,7 @@ declare function buildImport(className: string, source: string, isDefault: boole
  * @param name - The decorator function name to match against (e.g. 'Controller').
  * @returns The string argument value, an empty string if no argument is provided, or `null` if the decorator is not found.
  */
-declare function extractDecoratorArg(decorators: any[] | undefined, name: string): string | null;
+export declare function extractDecoratorArg(decorators: any[] | undefined, name: string): string | null;
 /**
  * Returns true if the given decorators array contains a decorator matching `name`.
  * Supports both `@Name` identifier and `@Name()` call expression styles.
@@ -45,7 +45,7 @@ declare function extractDecoratorArg(decorators: any[] | undefined, name: string
  * @param name - The decorator name to match.
  * @returns Whether a matching decorator exists.
  */
-declare function hasDecorator(decorators: any[] | undefined, name: string): boolean;
+export declare function hasDecorator(decorators: any[] | undefined, name: string): boolean;
 /**
  * Returns true if the class node extends a superclass with the given name.
  *
@@ -53,7 +53,7 @@ declare function hasDecorator(decorators: any[] | undefined, name: string): bool
  * @param name - The expected superclass identifier name.
  * @returns Whether the class extends the named superclass.
  */
-declare function extendsSuperClass(classNode: any, name: string): boolean;
+export declare function extendsSuperClass(classNode: any, name: string): boolean;
 /**
  * Normalizes a route path by removing duplicate slashes and ensuring
  * the path starts with a single leading slash.
@@ -61,7 +61,7 @@ declare function extendsSuperClass(classNode: any, name: string): boolean;
  * @param path - The raw concatenated path string to normalize.
  * @returns A cleaned path string with a leading slash and no duplicate separators.
  */
-declare function normalizePath(path: string): string;
+export declare function normalizePath(path: string): string;
 /**
  * Extracts named route parameters from a path string.
  *
@@ -71,13 +71,13 @@ declare function normalizePath(path: string): string;
  * @param route - The normalized route path to scan for parameters.
  * @returns An array of parameter name strings, empty if none are found.
  */
-declare function extractParams(route: string): string[];
+export declare function extractParams(route: string): string[];
 //#endregion
 //#region src/Types.d.ts
 /**
  * Basic information about a scanned source file.
  */
-type FileInfo = {
+export type FileInfo = {
   /** The path of the file relative to the directory it was scanned from. */
   path: string;
   /** The absolute path of the file on disk. */
@@ -86,7 +86,7 @@ type FileInfo = {
 /**
  * Represents a single extracted route from a controller class.
  */
-interface RouteInfo extends FileInfo {
+export interface RouteInfo extends FileInfo {
   /** The import statement required to load the controller class. */
   import: string;
   /** The name of the import statement. */
@@ -101,7 +101,7 @@ interface RouteInfo extends FileInfo {
 /**
  * Represents a single injectable service class discovered during scanning.
  */
-interface ServiceInfo extends FileInfo {
+export interface ServiceInfo extends FileInfo {
   /** The import statement required to load the service class. */
   import: string;
   /** The name of the imported class. */
@@ -110,7 +110,7 @@ interface ServiceInfo extends FileInfo {
 /**
  * Represents a single middleware class discovered during scanning.
  */
-interface MiddlewareInfo extends FileInfo {
+export interface MiddlewareInfo extends FileInfo {
   /** The import statement required to load the middleware class. */
   import: string;
   /** The name of the imported class. */
@@ -119,7 +119,7 @@ interface MiddlewareInfo extends FileInfo {
 /**
  * Minimal logger interface used to report non-fatal scanning issues.
  */
-interface ScanLogger {
+export interface ScanLogger {
   warn(message: string): void;
 }
 //#endregion
@@ -128,15 +128,15 @@ interface ScanLogger {
  * Placeholder module specifier embedded in generated route imports.
  * Callers resolve it to the real file path once known (see {@link Transform}).
  */
-declare const IMPORT_SOURCE = "#internal/vercube-route-plugin";
+export declare const IMPORT_SOURCE = "#internal/vercube-route-plugin";
 /**
  * Placeholder module specifier embedded in generated service imports.
  */
-declare const SERVICE_IMPORT_SOURCE = "#internal/vercube-service-source";
+export declare const SERVICE_IMPORT_SOURCE = "#internal/vercube-service-source";
 /**
  * Placeholder module specifier embedded in generated middleware imports.
  */
-declare const MIDDLEWARE_IMPORT_SOURCE = "#internal/vercube-middleware-source";
+export declare const MIDDLEWARE_IMPORT_SOURCE = "#internal/vercube-middleware-source";
 /**
  * Extracts all route definitions from the given TypeScript/JavaScript source code.
  *
@@ -149,7 +149,7 @@ declare const MIDDLEWARE_IMPORT_SOURCE = "#internal/vercube-middleware-source";
  * @param code - The raw TypeScript or JavaScript source code string to analyze.
  * @returns An array of {@link RouteInfo} objects representing all discovered routes.
  */
-declare function extractRoutes(code: string): RouteInfo[];
+export declare function extractRoutes(code: string): RouteInfo[];
 /**
  * Extracts every `@Controller`-decorated class from the given source code,
  * regardless of whether it declares HTTP method routes.
@@ -162,21 +162,21 @@ declare function extractRoutes(code: string): RouteInfo[];
  * @param code - The raw TypeScript or JavaScript source code string to analyze.
  * @returns An array of {@link ServiceInfo} objects for all discovered controller classes.
  */
-declare function extractControllers(code: string): ServiceInfo[];
+export declare function extractControllers(code: string): ServiceInfo[];
 /**
  * Extracts all `@Injectable`-decorated class definitions from the given source code.
  *
  * @param code - The raw TypeScript or JavaScript source code string to analyze.
  * @returns An array of {@link ServiceInfo} objects for all discovered injectable classes.
  */
-declare function extractServices(code: string): ServiceInfo[];
+export declare function extractServices(code: string): ServiceInfo[];
 /**
  * Extracts all class definitions that extend `BaseMiddleware` from the given source code.
  *
  * @param code - The raw TypeScript or JavaScript source code string to analyze.
  * @returns An array of {@link MiddlewareInfo} objects for all discovered middleware classes.
  */
-declare function extractMiddlewares(code: string): MiddlewareInfo[];
+export declare function extractMiddlewares(code: string): MiddlewareInfo[];
 //#endregion
 //#region src/Project.d.ts
 /**
@@ -185,7 +185,7 @@ declare function extractMiddlewares(code: string): MiddlewareInfo[];
  * `baseDirs` are the project source roots (e.g. `src/`). The remaining options
  * name the subdirectories scanned within each base root.
  */
-interface ScanProjectOptions {
+export interface ScanProjectOptions {
   /** Project source roots to scan within. */
   baseDirs: string[];
   /** Subdirectory holding API controllers. Defaults to `api`. */
@@ -206,7 +206,7 @@ interface ScanProjectOptions {
  * @param options - Where to scan. See {@link ScanProjectOptions}.
  * @returns The discovered routes with resolved imports.
  */
-declare function getRoutes(options: ScanProjectOptions): Promise<RouteInfo[]>;
+export declare function getRoutes(options: ScanProjectOptions): Promise<RouteInfo[]>;
 /**
  * Scans the configured service directories for `@Injectable` classes and returns
  * every service with its `import` resolved to the class's real file path.
@@ -214,7 +214,7 @@ declare function getRoutes(options: ScanProjectOptions): Promise<RouteInfo[]>;
  * @param options - Where to scan. See {@link ScanProjectOptions}.
  * @returns The discovered services with resolved imports.
  */
-declare function getServices(options: ScanProjectOptions): Promise<ServiceInfo[]>;
+export declare function getServices(options: ScanProjectOptions): Promise<ServiceInfo[]>;
 /**
  * Scans the middleware directory for `BaseMiddleware` subclasses and returns
  * every middleware with its `import` resolved to the class's real file path.
@@ -222,7 +222,7 @@ declare function getServices(options: ScanProjectOptions): Promise<ServiceInfo[]
  * @param options - Where to scan. See {@link ScanProjectOptions}.
  * @returns The discovered middleware with resolved imports.
  */
-declare function getMiddlewares(options: ScanProjectOptions): Promise<MiddlewareInfo[]>;
+export declare function getMiddlewares(options: ScanProjectOptions): Promise<MiddlewareInfo[]>;
 /**
  * Convenience wrapper that scans routes, services and middleware in one call.
  *
@@ -232,7 +232,7 @@ declare function getMiddlewares(options: ScanProjectOptions): Promise<Middleware
  * @param options - Where to scan. See {@link ScanProjectOptions}.
  * @returns The discovered routes, deduplicated services, and middleware.
  */
-declare function scanProject(options: ScanProjectOptions): Promise<{
+export declare function scanProject(options: ScanProjectOptions): Promise<{
   routes: RouteInfo[];
   services: ServiceInfo[];
   middlewares: MiddlewareInfo[];
@@ -240,7 +240,7 @@ declare function scanProject(options: ScanProjectOptions): Promise<{
 /**
  * Options for {@link scanSource}.
  */
-interface ScanSourceOptions {
+export interface ScanSourceOptions {
   /** Directories whose entire file tree is scanned for decorated classes. */
   dirs: string[];
   /** Optional logger forwarded to the underlying scanner. */
@@ -263,7 +263,7 @@ interface ScanSourceOptions {
  * @param options - Directories to scan. See {@link ScanSourceOptions}.
  * @returns The discovered controllers, HTTP routes, deduplicated services, and middleware, all with resolved imports.
  */
-declare function scanSource(options: ScanSourceOptions): Promise<{
+export declare function scanSource(options: ScanSourceOptions): Promise<{
   controllers: ServiceInfo[];
   routes: RouteInfo[];
   services: ServiceInfo[];
@@ -274,7 +274,7 @@ declare function scanSource(options: ScanSourceOptions): Promise<{
 /**
  * Glob pattern matching every source file extension the scanner understands.
  */
-declare const GLOB_SCAN_PATTERN = "**/*.{js,mjs,cjs,ts,mts,cts,tsx,jsx}";
+export declare const GLOB_SCAN_PATTERN = "**/*.{js,mjs,cjs,ts,mts,cts,tsx,jsx}";
 /**
  * Scans a single base directory for files inside the named subdirectory.
  *
@@ -287,7 +287,7 @@ declare const GLOB_SCAN_PATTERN = "**/*.{js,mjs,cjs,ts,mts,cts,tsx,jsx}";
  * @param logger - Optional logger used to warn when `<dir>/<name>` is not a directory.
  * @returns A sorted list of discovered files.
  */
-declare function scanDir(dir: string, name: string, logger?: ScanLogger): Promise<FileInfo[]>;
+export declare function scanDir(dir: string, name: string, logger?: ScanLogger): Promise<FileInfo[]>;
 /**
  * Scans every base directory for files inside the named subdirectory.
  *
@@ -296,7 +296,7 @@ declare function scanDir(dir: string, name: string, logger?: ScanLogger): Promis
  * @param logger - Optional logger forwarded to {@link scanDir}.
  * @returns The flattened list of discovered files across all base directories.
  */
-declare function scanFiles(baseDirs: string[], name: string, logger?: ScanLogger): Promise<FileInfo[]>;
+export declare function scanFiles(baseDirs: string[], name: string, logger?: ScanLogger): Promise<FileInfo[]>;
 //#endregion
 //#region src/Transform.d.ts
 /**
@@ -309,21 +309,21 @@ declare function scanFiles(baseDirs: string[], name: string, logger?: ScanLogger
  * @param file - File info (path and fullPath) to analyze.
  * @returns A list of {@link RouteInfo} for every route in the file.
  */
-declare function transformRoute(file: FileInfo): Promise<RouteInfo[]>;
+export declare function transformRoute(file: FileInfo): Promise<RouteInfo[]>;
 /**
  * Reads a file from disk and returns all `@Injectable`-decorated classes found within it.
  *
  * @param file - File info (path and fullPath) to analyze.
  * @returns A list of {@link ServiceInfo} for every injectable class in the file.
  */
-declare function transformService(file: FileInfo): Promise<ServiceInfo[]>;
+export declare function transformService(file: FileInfo): Promise<ServiceInfo[]>;
 /**
  * Reads a file from disk and returns all classes extending `BaseMiddleware` found within it.
  *
  * @param file - File info (path and fullPath) to analyze.
  * @returns A list of {@link MiddlewareInfo} for every middleware class in the file.
  */
-declare function transformMiddleware(file: FileInfo): Promise<MiddlewareInfo[]>;
+export declare function transformMiddleware(file: FileInfo): Promise<MiddlewareInfo[]>;
 /**
  * Replaces the placeholder import source in each entry with the entry's real
  * absolute file path, producing import statements that load the actual module.
@@ -332,9 +332,8 @@ declare function transformMiddleware(file: FileInfo): Promise<MiddlewareInfo[]>;
  * @param placeholder - The placeholder module specifier to replace.
  * @returns The entries with resolved `import` statements.
  */
-declare function resolveImports<T extends {
+export declare function resolveImports<T extends {
   import: string;
   fullPath: string;
 }>(entries: T[], placeholder: string): T[];
-//#endregion
-export { FileInfo, GLOB_SCAN_PATTERN, IMPORT_SOURCE, MIDDLEWARE_IMPORT_SOURCE, MiddlewareInfo, RouteInfo, SERVICE_IMPORT_SOURCE, ScanLogger, ScanProjectOptions, ScanSourceOptions, ServiceInfo, buildImport, extendsSuperClass, extractControllers, extractDecoratorArg, extractMiddlewares, extractParams, extractRoutes, extractServices, getClassNode, getMiddlewares, getRoutes, getServices, hasDecorator, normalizePath, resolveImports, scanDir, scanFiles, scanProject, scanSource, transformMiddleware, transformRoute, transformService };
+//#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercube/scan",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Source scanning and AST extraction utilities for the Vercube framework",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "framework"
   ],
   "dependencies": {
-    "oxc-parser": "0.144.0",
+    "oxc-parser": "0.151.0",
     "pathe": "2.0.3",
     "tinyglobby": "0.2.17"
   },