@pikku/inspector 0.8.0 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/inspector",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "author": "yasser.fadl@gmail.com",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
     "test:coverage": "bash run-tests.sh --coverage"
   },
   "dependencies": {
-    "@pikku/core": "^0.8.0",
+    "@pikku/core": "^0.9.0",
     "path-to-regexp": "^8.2.0",
     "typescript": "^5.6"
   },

package/src/add-channel.ts

@@ -1,14 +1,18 @@
 import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
 import { pathToRegexp } from 'path-to-regexp'
-import { APIDocs, PikkuEventTypes } from '@pikku/core'
+import { APIDocs, PikkuWiringTypes } from '@pikku/core'
 import {
   extractFunctionName,
   getPropertyAssignmentInitializer,
   matchesFilters,
 } from './utils.js'
 import type { ChannelMessageMeta, ChannelMeta } from '@pikku/core/channel'
-import type { InspectorFilters, InspectorState } from './types.js'
+import type {
+  InspectorFilters,
+  InspectorState,
+  InspectorLogger,
+} from './types.js'
 
 /**
  * Safely get the “initializer” expression of a property-like AST node:
@@ -103,11 +107,11 @@ export function addMessagesRoutes(
   obj: ts.ObjectLiteralExpression,
   state: InspectorState,
   checker: ts.TypeChecker
-): ChannelMeta['messageRoutes'] {
-  const result: ChannelMeta['messageRoutes'] = {}
+): ChannelMeta['messageWirings'] {
+  const result: ChannelMeta['messageWirings'] = {}
   const onMsgRouteProp = getPropertyAssignmentInitializer(
     obj,
-    'onMessageRoute',
+    'onMessageWiring',
     true,
     checker
   )
@@ -363,11 +367,12 @@ export function addChannel(
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) {
   if (!ts.isCallExpression(node)) return
   const { expression, arguments: args } = node
-  if (!ts.isIdentifier(expression) || expression.text !== 'addChannel') return
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireChannel') return
   const first = args[0]
   if (!first || !ts.isObjectLiteralExpression(first)) return
 
@@ -391,8 +396,15 @@ export function addChannel(
   const tags = getPropertyValue(obj, 'tags') as string[] | undefined
   const query = getPropertyValue(obj, 'query') as string[] | []
 
+  const filePath = node.getSourceFile().fileName
+
   if (
-    !matchesFilters(filters, { tags }, { type: PikkuEventTypes.channel, name })
+    !matchesFilters(
+      filters,
+      { tags },
+      { type: PikkuWiringTypes.channel, name, filePath },
+      logger
+    )
   )
     return
 
@@ -436,7 +448,7 @@ export function addChannel(
   }
 
   // nested message-routes
-  const messageRoutes = addMessagesRoutes(obj, state, checker)
+  const messageWirings = addMessagesRoutes(obj, state, checker)
 
   // record into state
   state.channels.files.add(node.getSourceFile().fileName)
@@ -463,7 +475,7 @@ export function addChannel(
         }
       : null,
     message,
-    messageRoutes,
+    messageWirings,
     docs: docs ?? undefined,
     tags: tags ?? undefined,
   }

package/src/add-file-extends-core-type.ts

@@ -1,8 +1,6 @@
 import * as ts from 'typescript'
 import { PathToNameAndType } from './types.js'
 
-// const VRAMEWORK_TYPES = ['CoreConfig', 'CoreService', 'CoreServices', 'CoreSingletonService', 'CoreSessionService']
-
 export const addFileExtendsCoreType = (
   node: ts.Node,
   checker: ts.TypeChecker,

package/src/add-functions.ts

@@ -1,5 +1,5 @@
 import * as ts from 'typescript'
-import { InspectorState, InspectorFilters } from './types.js'
+import { InspectorState, InspectorFilters, InspectorLogger } from './types.js'
 import { TypesMap } from './types-map.js'
 import {
   extractFunctionName,
@@ -231,7 +231,8 @@ export function addFunctions(
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) {
   if (!ts.isCallExpression(node)) return
 
@@ -305,10 +306,7 @@ export function addFunctions(
           services.services.push(original)
         }
       }
-    } else if (
-      ts.isIdentifier(firstParam.name) &&
-      !firstParam.name.text.startsWith('_')
-    ) {
+    } else if (ts.isIdentifier(firstParam.name)) {
       services.optimized = false
     }
   }

package/src/add-http-route.ts

@@ -2,13 +2,13 @@ import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
 import { pathToRegexp } from 'path-to-regexp'
 import { HTTPMethod } from '@pikku/core/http'
-import { APIDocs, PikkuEventTypes } from '@pikku/core'
+import { APIDocs, PikkuWiringTypes } from '@pikku/core'
 import {
   extractFunctionName,
   getPropertyAssignmentInitializer,
   matchesFilters,
 } from './utils.js'
-import { InspectorState, InspectorFilters } from './types.js'
+import { InspectorState, InspectorFilters, InspectorLogger } from './types.js'
 
 /**
  * Populate metaInputTypes for a given route based on method, input type,
@@ -36,20 +36,21 @@ export const getInputTypes = (
 }
 
 /**
- * Simplified addHTTPRoute: re-uses function metadata from state.functions.meta
+ * Simplified wireHTTP: re-uses function metadata from state.functions.meta
  * instead of re-inferring types here.
  */
 export const addHTTPRoute = (
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) => {
   // only look at calls
   if (!ts.isCallExpression(node)) return
 
   const { expression, arguments: args } = node
-  if (!ts.isIdentifier(expression) || expression.text !== 'addHTTPRoute') return
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireHTTP') return
 
   // must pass an object literal
   const firstArg = args[0]
@@ -69,11 +70,14 @@ export const addHTTPRoute = (
   const tags = (getPropertyValue(obj, 'tags') as string[]) || undefined
   const query = (getPropertyValue(obj, 'query') as string[]) || []
 
+  const filePath = node.getSourceFile().fileName
+
   if (
     !matchesFilters(
       filters,
       { tags },
-      { type: PikkuEventTypes.http, name: route }
+      { type: PikkuWiringTypes.http, name: route, filePath },
+      logger
     )
   ) {
     return

package/src/add-mcp-prompt.ts

@@ -1,7 +1,7 @@
 import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
-import { PikkuEventTypes } from '@pikku/core'
-import { InspectorFilters, InspectorState } from './types.js'
+import { PikkuWiringTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState, InspectorLogger } from './types.js'
 import {
   extractFunctionName,
   getPropertyAssignmentInitializer,
@@ -12,7 +12,8 @@ export const addMCPPrompt = (
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) => {
   if (!ts.isCallExpression(node)) {
     return
@@ -22,8 +23,8 @@ export const addMCPPrompt = (
   const firstArg = args[0]
   const expression = node.expression
 
-  // Check if the call is to addMCPPrompt
-  if (!ts.isIdentifier(expression) || expression.text !== 'addMCPPrompt') {
+  // Check if the call is to wireMCPPrompt
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireMCPPrompt') {
     return
   }
 
@@ -66,11 +67,14 @@ export const addMCPPrompt = (
       return
     }
 
+    const filePath = node.getSourceFile().fileName
+
     if (
       !matchesFilters(
         filters,
         { tags },
-        { type: PikkuEventTypes.mcp, name: nameValue }
+        { type: PikkuWiringTypes.mcp, name: nameValue, filePath },
+        logger
       )
     ) {
       return

package/src/add-mcp-resource.ts

@@ -1,7 +1,7 @@
 import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
-import { PikkuEventTypes } from '@pikku/core'
-import { InspectorFilters, InspectorState } from './types.js'
+import { PikkuWiringTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState, InspectorLogger } from './types.js'
 import {
   extractFunctionName,
   getPropertyAssignmentInitializer,
@@ -12,7 +12,8 @@ export const addMCPResource = (
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) => {
   if (!ts.isCallExpression(node)) {
     return
@@ -22,8 +23,8 @@ export const addMCPResource = (
   const firstArg = args[0]
   const expression = node.expression
 
-  // Check if the call is to addMCPResource
-  if (!ts.isIdentifier(expression) || expression.text !== 'addMCPResource') {
+  // Check if the call is to wireMCPResource
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireMCPResource') {
     return
   }
 
@@ -77,11 +78,14 @@ export const addMCPResource = (
       return
     }
 
+    const filePath = node.getSourceFile().fileName
+
     if (
       !matchesFilters(
         filters,
         { tags },
-        { type: PikkuEventTypes.mcp, name: uriValue }
+        { type: PikkuWiringTypes.mcp, name: uriValue, filePath },
+        logger
       )
     ) {
       return

package/src/add-mcp-tool.ts

@@ -1,7 +1,7 @@
 import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
-import { PikkuEventTypes } from '@pikku/core'
-import { InspectorFilters, InspectorState } from './types.js'
+import { PikkuWiringTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState, InspectorLogger } from './types.js'
 import {
   extractFunctionName,
   getPropertyAssignmentInitializer,
@@ -12,7 +12,8 @@ export const addMCPTool = (
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) => {
   if (!ts.isCallExpression(node)) {
     return
@@ -22,8 +23,8 @@ export const addMCPTool = (
   const firstArg = args[0]
   const expression = node.expression
 
-  // Check if the call is to addMCPTool
-  if (!ts.isIdentifier(expression) || expression.text !== 'addMCPTool') {
+  // Check if the call is to wireMCPTool
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireMCPTool') {
     return
   }
 
@@ -68,11 +69,14 @@ export const addMCPTool = (
       return
     }
 
+    const filePath = node.getSourceFile().fileName
+
     if (
       !matchesFilters(
         filters,
         { tags },
-        { type: PikkuEventTypes.mcp, name: nameValue }
+        { type: PikkuWiringTypes.mcp, name: nameValue, filePath },
+        logger
       )
     ) {
       return

package/src/add-queue-worker.ts

@@ -1,7 +1,7 @@
 import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
-import { APIDocs, PikkuEventTypes } from '@pikku/core'
-import { InspectorFilters, InspectorState } from './types.js'
+import { APIDocs, PikkuWiringTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState, InspectorLogger } from './types.js'
 import {
   extractFunctionName,
   getPropertyAssignmentInitializer,
@@ -12,7 +12,8 @@ export const addQueueWorker = (
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) => {
   if (!ts.isCallExpression(node)) {
     return
@@ -23,7 +24,7 @@ export const addQueueWorker = (
   const expression = node.expression
 
   // Check if the call is to addQueueWorker
-  if (!ts.isIdentifier(expression) || expression.text !== 'addQueueWorker') {
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireQueueWorker') {
     return
   }
 
@@ -64,11 +65,14 @@ export const addQueueWorker = (
       return
     }
 
+    const filePath = node.getSourceFile().fileName
+
     if (
       !matchesFilters(
         filters,
         { tags },
-        { type: PikkuEventTypes.queue, name: queueName }
+        { type: PikkuWiringTypes.queue, name: queueName, filePath },
+        logger
       )
     ) {
       console.info(

package/src/add-schedule.ts

@@ -1,7 +1,7 @@
 import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
-import { APIDocs, PikkuEventTypes } from '@pikku/core'
-import { InspectorFilters, InspectorState } from './types.js'
+import { APIDocs, PikkuWiringTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState, InspectorLogger } from './types.js'
 import {
   extractFunctionName,
   getPropertyAssignmentInitializer,
@@ -12,7 +12,8 @@ export const addSchedule = (
   node: ts.Node,
   checker: ts.TypeChecker,
   state: InspectorState,
-  filters: InspectorFilters
+  filters: InspectorFilters,
+  logger: InspectorLogger
 ) => {
   if (!ts.isCallExpression(node)) {
     return
@@ -23,7 +24,7 @@ export const addSchedule = (
   const expression = node.expression
 
   // Check if the call is to addScheduledTask
-  if (!ts.isIdentifier(expression) || expression.text !== 'addScheduledTask') {
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireScheduler') {
     return
   }
 
@@ -61,11 +62,14 @@ export const addSchedule = (
       return
     }
 
+    const filePath = node.getSourceFile().fileName
+
     if (
       !matchesFilters(
         filters,
         { tags },
-        { type: PikkuEventTypes.scheduled, name: nameValue }
+        { type: PikkuWiringTypes.scheduler, name: nameValue, filePath },
+        logger
       )
     ) {
       return

package/src/inspector.ts

@@ -5,6 +5,7 @@ import {
   InspectorState,
   InspectorHTTPState,
   InspectorFilters,
+  InspectorLogger,
 } from './types.js'
 
 export const normalizeHTTPTypes = (
@@ -14,6 +15,7 @@ export const normalizeHTTPTypes = (
 }
 
 export const inspect = (
+  logger: InspectorLogger,
   routeFiles: string[],
   filters: InspectorFilters
 ): InspectorState => {
@@ -67,14 +69,14 @@ export const inspect = (
   // First sweep: add all functions
   for (const sourceFile of sourceFiles) {
     ts.forEachChild(sourceFile, (child) =>
-      visitSetup(checker, child, state, filters)
+      visitSetup(checker, child, state, filters, logger)
     )
   }
 
   // Second sweep: add all transports
   for (const sourceFile of sourceFiles) {
     ts.forEachChild(sourceFile, (child) =>
-      visitRoutes(checker, child, state, filters)
+      visitRoutes(checker, child, state, filters, logger)
     )
   }
 

package/src/types.ts

@@ -1,5 +1,5 @@
 import { ChannelsMeta } from '@pikku/core/channel'
-import { HTTPRoutesMeta } from '@pikku/core/http'
+import { HTTPWiringsMeta } from '@pikku/core/http'
 import { ScheduledTasksMeta } from '@pikku/core/scheduler'
 import { queueWorkersMeta } from '@pikku/core/queue'
 import { MCPResourceMeta, MCPToolMeta, MCPPromptMeta } from '@pikku/core'
@@ -23,7 +23,7 @@ export type MetaInputTypes = Map<
 
 export interface InspectorHTTPState {
   metaInputTypes: MetaInputTypes
-  meta: HTTPRoutesMeta
+  meta: HTTPWiringsMeta
   files: Set<string>
 }
 
@@ -40,6 +40,15 @@ export interface InspectorChannelState {
 
 export type InspectorFilters = {
   tags?: string[]
+  types?: string[]
+  directories?: string[]
+}
+
+export interface InspectorLogger {
+  info: (message: string) => void
+  error: (message: string) => void
+  warn: (message: string) => void
+  debug: (message: string) => void
 }
 export interface InspectorState {
   singletonServicesTypeImportMap: PathToNameAndType