@pikku/inspector 0.11.0 → 0.11.2

package/src/utils/filter-utils.test.ts

@@ -1,6 +1,5 @@
 import { test, describe } from 'node:test'
 import { strict as assert } from 'node:assert'
-import { PikkuWiringTypes } from '@pikku/core'
 import { InspectorFilters } from '../types'
 import { matchesFilters, matchesWildcard } from './filter-utils'
 
@@ -11,6 +10,8 @@ describe('matchesFilters', () => {
     error: () => {},
     warn: () => {},
     debug: () => {},
+    critical: () => {},
+    hasCriticalErrors: () => false,
   }
 
   describe('Empty filters', () => {
@@ -20,7 +21,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['test'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -37,7 +38,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['test'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -54,7 +55,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['api', 'internal'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -69,7 +70,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['internal', 'private'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -84,7 +85,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: undefined },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -99,7 +100,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: [] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -116,7 +117,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['test'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -131,7 +132,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['test'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -139,14 +140,7 @@ describe('matchesFilters', () => {
     })
 
     test('should handle all PikkuWiringTypes correctly', () => {
-      const eventTypes = [
-        PikkuWiringTypes.http,
-        PikkuWiringTypes.channel,
-        PikkuWiringTypes.queue,
-        PikkuWiringTypes.scheduler,
-        PikkuWiringTypes.rpc,
-        PikkuWiringTypes.mcp,
-      ]
+      const eventTypes = ['http', 'channel', 'queue', 'scheduler', 'rpc', 'mcp']
 
       eventTypes.forEach((eventType) => {
         const filters: InspectorFilters = {
@@ -175,7 +169,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api/routes.ts',
         },
@@ -194,7 +188,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/public/routes.ts',
         },
@@ -213,7 +207,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: 'C:\\project\\src\\api\\routes.ts',
         },
@@ -232,7 +226,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: 'C:\\project\\src\\api\\routes.ts',
         },
@@ -250,7 +244,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['test'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' }, // no filePath
+        { type: 'http', name: 'test-route' }, // no filePath
         mockLogger
       )
 
@@ -266,7 +260,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api/v1/routes.ts',
         },
@@ -289,7 +283,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['api', 'public'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api/routes.ts',
         },
@@ -310,7 +304,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['api', 'public'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api/routes.ts',
         },
@@ -331,7 +325,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['api', 'public'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api/routes.ts',
         },
@@ -352,7 +346,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['api', 'public'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api/routes.ts',
         },
@@ -372,7 +366,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: undefined },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -387,7 +381,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['test'] },
-        { type: PikkuWiringTypes.http, name: '' },
+        { type: 'http', name: '' },
         mockLogger
       )
 
@@ -403,7 +397,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api-v2/routes.ts',
         },
@@ -422,7 +416,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/api/routes.ts',
         },
@@ -440,7 +434,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['api', 'public', 'v1'] },
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -455,7 +449,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { tags: ['test'] },
-        { type: PikkuWiringTypes.channel, name: 'test-channel' },
+        { type: 'channel', name: 'test-channel' },
         mockLogger
       )
 
@@ -471,7 +465,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['test'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'test-route',
           filePath: '/project/src/internal/routes.ts',
         },
@@ -491,7 +485,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { name: 'email-worker' },
-        { type: PikkuWiringTypes.queue, name: 'email-queue' },
+        { type: 'queue', name: 'email-queue' },
         mockLogger
       )
 
@@ -506,7 +500,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { name: 'email-worker' },
-        { type: PikkuWiringTypes.queue, name: 'email-queue' },
+        { type: 'queue', name: 'email-queue' },
         mockLogger
       )
 
@@ -521,7 +515,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { name: 'notification-worker' },
-        { type: PikkuWiringTypes.queue, name: 'notification-queue' },
+        { type: 'queue', name: 'notification-queue' },
         mockLogger
       )
 
@@ -536,7 +530,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         {},
-        { type: PikkuWiringTypes.http, name: 'test-route' },
+        { type: 'http', name: 'test-route' },
         mockLogger
       )
 
@@ -551,7 +545,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         { name: 'email-worker' },
-        { type: PikkuWiringTypes.queue, name: 'other-name' },
+        { type: 'queue', name: 'other-name' },
         mockLogger
       )
 
@@ -569,7 +563,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpRoute: '/api/users',
         },
@@ -588,7 +582,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpRoute: '/api/users',
         },
@@ -607,7 +601,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'webhook-route',
           httpRoute: '/webhooks/stripe',
         },
@@ -625,7 +619,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         {},
-        { type: PikkuWiringTypes.queue, name: 'worker' },
+        { type: 'queue', name: 'worker' },
         mockLogger
       )
 
@@ -641,7 +635,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'webhook-route',
           httpRoute: '/webhooks/stripe',
         },
@@ -662,7 +656,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpMethod: 'GET',
         },
@@ -681,7 +675,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpMethod: 'DELETE',
         },
@@ -700,7 +694,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpMethod: 'get',
         },
@@ -718,7 +712,7 @@ describe('matchesFilters', () => {
       const result = matchesFilters(
         filters,
         {},
-        { type: PikkuWiringTypes.queue, name: 'worker' },
+        { type: 'queue', name: 'worker' },
         mockLogger
       )
 
@@ -739,7 +733,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['api'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpRoute: '/api/users',
           httpMethod: 'GET',
@@ -760,7 +754,7 @@ describe('matchesFilters', () => {
         filters,
         { tags: ['api'] },
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpRoute: '/api/users',
         },
@@ -780,7 +774,7 @@ describe('matchesFilters', () => {
         filters,
         {},
         {
-          type: PikkuWiringTypes.http,
+          type: 'http',
           name: 'users-route',
           httpRoute: '/api/users',
           httpMethod: 'GET',

package/src/utils/get-files-and-methods.ts

@@ -13,12 +13,12 @@ interface Meta {
 
 export type FilesAndMethods = {
   userSessionType: Meta
-  sessionServicesType: Meta
+  wireServicesType: Meta
   singletonServicesType: Meta
   pikkuConfigType: Meta
   pikkuConfigFactory: Meta
   singletonServicesFactory: Meta
-  sessionServicesFactory: Meta
+  wireServicesFactory: Meta
 }
 
 export type FilesAndMethodsErrors = Map<string, PathToNameAndType>
@@ -86,10 +86,10 @@ const getMetaTypes = (
 export const getFilesAndMethods = (
   {
     singletonServicesTypeImportMap,
-    sessionServicesTypeImportMap,
+    wireServicesTypeImportMap,
     userSessionTypeImportMap,
     configTypeImportMap,
-    sessionServicesFactories,
+    wireServicesFactories,
     singletonServicesFactories,
     configFactories,
   }: InspectorState,
@@ -97,7 +97,7 @@ export const getFilesAndMethods = (
     configFileType,
     userSessionType,
     singletonServicesFactoryType,
-    sessionServicesFactoryType,
+    wireServicesFactoryType,
   }: InspectorOptions['types'] = {}
 ): { result: Partial<FilesAndMethods>; errors: FilesAndMethodsErrors } => {
   const errors: FilesAndMethodsErrors = new Map()
@@ -115,9 +115,9 @@ export const getFilesAndMethods = (
       undefined,
       errors
     ),
-    sessionServicesType: getMetaTypes(
+    wireServicesType: getMetaTypes(
       'CoreServices',
-      sessionServicesTypeImportMap,
+      wireServicesTypeImportMap,
       undefined,
       errors
     ),
@@ -139,10 +139,10 @@ export const getFilesAndMethods = (
       singletonServicesFactoryType,
       errors
     ),
-    sessionServicesFactory: getMetaTypes(
-      'CreateSessionServices',
-      sessionServicesFactories,
-      sessionServicesFactoryType,
+    wireServicesFactory: getMetaTypes(
+      'CreateWireServices',
+      wireServicesFactories,
+      wireServicesFactoryType,
       errors
     ),
   }

package/src/utils/get-property-value.ts

@@ -1,11 +1,10 @@
-import { PikkuDocs } from '@pikku/core'
 import * as ts from 'typescript'
 import { ErrorCode } from '../error-codes.js'
 
 export const getPropertyValue = (
   obj: ts.ObjectLiteralExpression,
   propertyName: string
-): string | string[] | null | PikkuDocs | boolean => {
+): string | string[] | null | boolean => {
   const property = obj.properties.find(
     (p) =>
       ts.isPropertyAssignment(p) &&
@@ -33,42 +32,6 @@ export const getPropertyValue = (
       return stringArray.length > 0 ? stringArray : null
     }
 
-    // Special handling for 'docs' -> expect RouteDocs
-    if (propertyName === 'docs' && ts.isObjectLiteralExpression(initializer)) {
-      const docs: PikkuDocs = {}
-
-      initializer.properties.forEach((prop) => {
-        if (ts.isPropertyAssignment(prop) && ts.isIdentifier(prop.name)) {
-          const propName = prop.name.text
-
-          if (propName === 'summary' && ts.isStringLiteral(prop.initializer)) {
-            docs.summary = prop.initializer.text
-          } else if (
-            propName === 'description' &&
-            ts.isStringLiteral(prop.initializer)
-          ) {
-            docs.description = prop.initializer.text
-          } else if (
-            propName === 'tags' &&
-            ts.isArrayLiteralExpression(prop.initializer)
-          ) {
-            docs.tags = prop.initializer.elements
-              .filter(ts.isStringLiteral)
-              .map((element) => element.text)
-          } else if (
-            propName === 'errors' &&
-            ts.isArrayLiteralExpression(prop.initializer)
-          ) {
-            docs.errors = prop.initializer.elements
-              .filter(ts.isIdentifier)
-              .map((element) => element.text as unknown as string)
-          }
-        }
-      })
-
-      return docs
-    }
-
     // booleans -> true/false
     if (initializer.kind === ts.SyntaxKind.TrueKeyword) {
       return true
@@ -94,27 +57,78 @@ export const getPropertyValue = (
 }
 
 /**
- * Gets the 'tags' property from an object and validates it's an array.
- * Logs a critical error if tags is not an array but still returns the value.
+ * Extracts common wire metadata (title, tags, summary, description, errors) directly from an object
+ * @param obj - The TypeScript object literal expression to extract metadata from
+ * @param wiringType - The type of wiring (e.g., 'HTTP route', 'Channel', 'Queue worker')
+ * @param wiringName - The name/identifier of the wiring (e.g., route path, channel name)
  * @param logger - Optional logger instance; if not provided, uses console.error
+ * @returns Object containing the common wire metadata fields
  */
-export const getPropertyTags = (
+export const getCommonWireMetaData = (
   obj: ts.ObjectLiteralExpression,
   wiringType: string,
   wiringName: string | null,
   logger?: { critical: (code: ErrorCode, message: string) => void }
-): string[] | undefined => {
-  const tagsValue = getPropertyValue(obj, 'tags')
-
-  if (tagsValue !== null && !Array.isArray(tagsValue)) {
-    const errorMsg = `${wiringType} '${wiringName}' has invalid 'tags' property - must be an array of strings.`
-    if (logger) {
-      logger.critical(ErrorCode.INVALID_TAGS_TYPE, errorMsg)
-    } else {
-      console.error(errorMsg)
+): {
+  title?: string
+  tags?: string[]
+  summary?: string
+  description?: string
+  errors?: string[]
+} => {
+  const metadata: {
+    title?: string
+    tags?: string[]
+    summary?: string
+    description?: string
+    errors?: string[]
+  } = {}
+
+  obj.properties.forEach((prop) => {
+    if (ts.isPropertyAssignment(prop) && ts.isIdentifier(prop.name)) {
+      const propName = prop.name.text
+
+      if (propName === 'title' && ts.isStringLiteral(prop.initializer)) {
+        metadata.title = prop.initializer.text
+      } else if (
+        propName === 'summary' &&
+        ts.isStringLiteral(prop.initializer)
+      ) {
+        metadata.summary = prop.initializer.text
+      } else if (
+        propName === 'description' &&
+        ts.isStringLiteral(prop.initializer)
+      ) {
+        metadata.description = prop.initializer.text
+      } else if (propName === 'tags') {
+        if (ts.isArrayLiteralExpression(prop.initializer)) {
+          metadata.tags = prop.initializer.elements
+            .filter(ts.isStringLiteral)
+            .map((element) => element.text)
+        } else {
+          const errorMsg = `${wiringType} '${wiringName}' has invalid 'tags' property - must be an array of strings.`
+          if (logger) {
+            logger.critical(ErrorCode.INVALID_TAGS_TYPE, errorMsg)
+          } else {
+            console.error(errorMsg)
+          }
+        }
+      } else if (propName === 'errors') {
+        if (ts.isArrayLiteralExpression(prop.initializer)) {
+          metadata.errors = prop.initializer.elements
+            .filter(ts.isIdentifier)
+            .map((element) => element.text as unknown as string)
+        } else {
+          const errorMsg = `${wiringType} '${wiringName}' has invalid 'errors' property - must be an array of error identifiers.`
+          if (logger) {
+            logger.critical(ErrorCode.INVALID_TAGS_TYPE, errorMsg)
+          } else {
+            console.error(errorMsg)
+          }
+        }
+      }
     }
-    // Return undefined but don't stop processing - error will be caught by the exit handler
-  }
+  })
 
-  return Array.isArray(tagsValue) ? tagsValue : undefined
+  return metadata
 }

package/src/utils/permissions.test.ts

@@ -256,12 +256,12 @@ function createMockObjectLiteral(): any {
 function createMockState(): InspectorState {
   return {
     singletonServicesTypeImportMap: new Map(),
-    sessionServicesTypeImportMap: new Map(),
+    wireServicesTypeImportMap: new Map(),
     userSessionTypeImportMap: new Map(),
     configTypeImportMap: new Map(),
     singletonServicesFactories: new Map(),
-    sessionServicesFactories: new Map(),
-    sessionServicesMeta: new Map(),
+    wireServicesFactories: new Map(),
+    wireServicesMeta: new Map(),
     configFactories: new Map(),
     filesAndMethods: {},
     filesAndMethodsErrors: new Map(),