@pikku/inspector 0.12.1 → 0.12.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## 0.12.0
 
+## 0.12.2
+
+### Patch Changes
+
+- 3e04565: chore: update dependencies to latest minor/patch versions
+- Updated dependencies [cc4c9e9]
+- Updated dependencies [3e04565]
+  - @pikku/core@0.12.2
+
 ## 0.12.1
 
 ### Patch Changes

package/dist/add/add-channel.js

@@ -366,6 +366,7 @@ export const addChannel = (logger, node, checker, state, options) => {
     if (disabled)
         return;
     const query = getPropertyValue(obj, 'query');
+    const binary = getPropertyValue(obj, 'binary');
     const connect = getPropertyAssignmentInitializer(obj, 'onConnect', true, checker);
     const disconnect = getPropertyAssignmentInitializer(obj, 'onDisconnect', true, checker);
     // default onMessage handler
@@ -439,6 +440,7 @@ export const addChannel = (logger, node, checker, state, options) => {
         disconnect: disconnectFuncId ? { pikkuFuncId: disconnectFuncId } : null,
         message,
         messageWirings,
+        binary: binary === undefined ? undefined : binary,
         summary,
         description,
         errors,

package/dist/add/add-cli.js

@@ -1,5 +1,5 @@
 import ts from 'typescript';
-import { extractFunctionName } from '../utils/extract-function-name.js';
+import { extractFunctionName, makeContextBasedId, } from '../utils/extract-function-name.js';
 import { resolveMiddleware } from '../utils/middleware.js';
 import { extractWireNames } from '../utils/post-process.js';
 import { getPropertyValue } from '../utils/get-property-value.js';
@@ -95,10 +95,14 @@ function processCLIConfig(logger, node, sourceFile, typeChecker, inspectorState,
                     programMeta.options = processOptions(logger, prop.initializer, typeChecker, inspectorState, options);
                 }
                 break;
-            case 'render':
-                // Extract the actual renderer function name
-                programMeta.defaultRenderName = extractFunctionName(prop.initializer, typeChecker, inspectorState.rootDir).pikkuFuncId;
+            case 'render': {
+                let renderFuncId = extractFunctionName(prop.initializer, typeChecker, inspectorState.rootDir).pikkuFuncId;
+                if (renderFuncId.startsWith('__temp_')) {
+                    renderFuncId = makeContextBasedId('cli-render', programName);
+                }
+                programMeta.defaultRenderName = renderFuncId;
                 break;
+            }
         }
     }
     return { programName, programMeta };
@@ -156,8 +160,12 @@ function processCommand(logger, inspectorState, options, name, node, sourceFile,
     if (ts.isIdentifier(node) ||
         ts.isArrowFunction(node) ||
         ts.isFunctionExpression(node)) {
+        let pikkuFuncId = extractFunctionName(node, typeChecker, inspectorState.rootDir).pikkuFuncId;
+        if (pikkuFuncId.startsWith('__temp_')) {
+            pikkuFuncId = makeContextBasedId('cli', programName, ...fullPath);
+        }
         return {
-            pikkuFuncId: extractFunctionName(node, typeChecker, inspectorState.rootDir).pikkuFuncId,
+            pikkuFuncId,
             positionals: [],
             options: {},
         };
@@ -195,6 +203,9 @@ function processCommand(logger, inspectorState, options, name, node, sourceFile,
         const propName = prop.name.text;
         if (propName === 'func') {
             pikkuFuncId = extractFunctionName(prop.initializer, typeChecker, inspectorState.rootDir).pikkuFuncId;
+            if (pikkuFuncId.startsWith('__temp_')) {
+                pikkuFuncId = makeContextBasedId('cli', programName, ...fullPath);
+            }
             meta.pikkuFuncId = pikkuFuncId;
         }
         else if (propName === 'options' &&
@@ -238,9 +249,14 @@ function processCommand(logger, inspectorState, options, name, node, sourceFile,
             case 'func':
                 // Already handled in first pass
                 break;
-            case 'render':
-                meta.renderName = extractFunctionName(prop.initializer, typeChecker, inspectorState.rootDir).pikkuFuncId;
+            case 'render': {
+                let renderFuncId = extractFunctionName(prop.initializer, typeChecker, inspectorState.rootDir).pikkuFuncId;
+                if (renderFuncId.startsWith('__temp_')) {
+                    renderFuncId = makeContextBasedId('cli-render', programName, ...fullPath);
+                }
+                meta.renderName = renderFuncId;
                 break;
+            }
             case 'options':
                 // Process with pikkuFuncId from first pass
                 if (optionsNode) {

package/dist/add/add-gateway.d.ts

@@ -0,0 +1,2 @@
+import type { AddWiring } from '../types.js';
+export declare const addGateway: AddWiring;

package/dist/add/add-gateway.js

@@ -0,0 +1,57 @@
+import * as ts from 'typescript';
+import { getPropertyValue, getCommonWireMetaData, } from '../utils/get-property-value.js';
+import { extractFunctionName, makeContextBasedId, } from '../utils/extract-function-name.js';
+import { getPropertyAssignmentInitializer } from '../utils/type-utils.js';
+import { resolveMiddleware } from '../utils/middleware.js';
+import { extractWireNames } from '../utils/post-process.js';
+import { ErrorCode } from '../error-codes.js';
+export const addGateway = (logger, node, checker, state, _options) => {
+    if (!ts.isCallExpression(node)) {
+        return;
+    }
+    const args = node.arguments;
+    const firstArg = args[0];
+    const expression = node.expression;
+    if (!ts.isIdentifier(expression) || expression.text !== 'wireGateway') {
+        return;
+    }
+    if (!firstArg || !ts.isObjectLiteralExpression(firstArg)) {
+        return;
+    }
+    const obj = firstArg;
+    const nameValue = getPropertyValue(obj, 'name');
+    const typeValue = getPropertyValue(obj, 'type');
+    const routeValue = getPropertyValue(obj, 'route');
+    const { disabled, tags, summary, description, errors } = getCommonWireMetaData(obj, 'Gateway', nameValue, logger);
+    if (disabled)
+        return;
+    const funcInitializer = getPropertyAssignmentInitializer(obj, 'func', true, checker);
+    if (!funcInitializer) {
+        logger.critical(ErrorCode.MISSING_FUNC, `No valid 'func' property for gateway '${nameValue}'.`);
+        return;
+    }
+    const extracted = extractFunctionName(funcInitializer, checker, state.rootDir);
+    let pikkuFuncId = extracted.pikkuFuncId;
+    if (pikkuFuncId.startsWith('__temp_') && nameValue) {
+        pikkuFuncId = makeContextBasedId('gateway', nameValue);
+    }
+    if (!nameValue || !typeValue) {
+        return;
+    }
+    const middleware = resolveMiddleware(state, obj, tags, checker);
+    state.serviceAggregation.usedFunctions.add(pikkuFuncId);
+    extractWireNames(middleware).forEach((name) => state.serviceAggregation.usedMiddleware.add(name));
+    state.gateways.files.add(node.getSourceFile().fileName);
+    state.gateways.meta[nameValue] = {
+        pikkuFuncId,
+        name: nameValue,
+        type: typeValue,
+        route: routeValue,
+        gateway: true,
+        summary,
+        description,
+        errors,
+        tags,
+        middleware,
+    };
+};

package/dist/inspector.js

@@ -57,6 +57,10 @@ export function getInitialInspectorState(rootDir) {
             files: new Set(),
             meta: {},
         },
+        gateways: {
+            meta: {},
+            files: new Set(),
+        },
         triggers: {
             meta: {},
             sourceMeta: {},

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type * as ts from 'typescript';
 import type { ChannelsMeta } from '@pikku/core/channel';
+import type { GatewaysMeta } from '@pikku/core/gateway';
 import type { HTTPWiringsMeta } from '@pikku/core/http';
 import type { ScheduledTasksMeta } from '@pikku/core/scheduler';
 import type { TriggerMeta, TriggerSourceMeta } from '@pikku/core/trigger';
@@ -262,6 +263,10 @@ export interface InspectorState {
     http: InspectorHTTPState;
     functions: InspectorFunctionState;
     channels: InspectorChannelState;
+    gateways: {
+        meta: GatewaysMeta;
+        files: Set<string>;
+    };
     triggers: {
         meta: TriggerMeta;
         sourceMeta: TriggerSourceMeta;

package/dist/utils/serialize-inspector-state.d.ts

@@ -125,6 +125,10 @@ export interface SerializableInspectorState {
         files: string[];
         meta: InspectorState['channels']['meta'];
     };
+    gateways: {
+        meta: InspectorState['gateways']['meta'];
+        files: string[];
+    };
     triggers: {
         meta: InspectorState['triggers']['meta'];
         sourceMeta: InspectorState['triggers']['sourceMeta'];

package/dist/utils/serialize-inspector-state.js

@@ -44,6 +44,10 @@ export function serializeInspectorState(state) {
             files: Array.from(state.channels.files),
             meta: state.channels.meta,
         },
+        gateways: {
+            meta: state.gateways.meta,
+            files: Array.from(state.gateways.files),
+        },
         triggers: {
             meta: state.triggers.meta,
             sourceMeta: state.triggers.sourceMeta,
@@ -181,6 +185,10 @@ export function deserializeInspectorState(data) {
             files: new Set(data.channels.files),
             meta: data.channels.meta,
         },
+        gateways: {
+            meta: data.gateways?.meta ?? {},
+            files: new Set(data.gateways?.files ?? []),
+        },
         triggers: {
             meta: data.triggers?.meta ?? {},
             sourceMeta: data.triggers?.sourceMeta ?? {},

package/dist/visit.js

@@ -11,6 +11,7 @@ import { addMCPResource } from './add/add-mcp-resource.js';
 import { addMCPPrompt } from './add/add-mcp-prompt.js';
 import { addFunctions } from './add/add-functions.js';
 import { addChannel } from './add/add-channel.js';
+import { addGateway } from './add/add-gateway.js';
 import { addRPCInvocations } from './add/add-rpc-invocations.js';
 import { addWireAddon } from './add/add-wire-addon.js';
 import { addMiddleware } from './add/add-middleware.js';
@@ -46,6 +47,7 @@ export const visitRoutes = (logger, checker, node, state, options) => {
     addTrigger(logger, node, checker, state, options);
     addQueueWorker(logger, node, checker, state, options);
     addChannel(logger, node, checker, state, options);
+    addGateway(logger, node, checker, state, options);
     addCLI(logger, node, checker, state, options);
     addCLIRenderers(logger, node, checker, state, options);
     addMCPResource(logger, node, checker, state, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/inspector",
-  "version": "0.12.1",
+  "version": "0.12.2",
   "author": "yasser.fadl@gmail.com",
   "license": "BUSL-1.1",
   "type": "module",
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@openapi-contrib/json-schema-to-openapi-schema": "^4.3.1",
-    "@pikku/core": "^0.12.1",
+    "@pikku/core": "^0.12.2",
     "path-to-regexp": "^8.3.0",
     "ts-json-schema-generator": "^2.5.0",
     "tsx": "^4.21.0",
@@ -43,7 +43,7 @@
     "zod-to-ts": "^2.0.0"
   },
   "devDependencies": {
-    "@types/node": "^24.10.12"
+    "@types/node": "^24.11.0"
   },
   "engines": {
     "node": ">=18"

package/src/add/add-channel.ts

@@ -527,6 +527,7 @@ export const addChannel: AddWiring = (
   if (disabled) return
 
   const query = getPropertyValue(obj, 'query') as string[] | []
+  const binary = getPropertyValue(obj, 'binary') as boolean | undefined
 
   const connect = getPropertyAssignmentInitializer(
     obj,
@@ -620,13 +621,7 @@ export const addChannel: AddWiring = (
   ].filter(Boolean) as string[]
   for (const funcId of handlersToValidate) {
     if (
-      !validateAuthSessionless(
-        logger,
-        obj,
-        state,
-        funcId,
-        `Channel '${name}'`
-      )
+      !validateAuthSessionless(logger, obj, state, funcId, `Channel '${name}'`)
     ) {
       return
     }
@@ -643,6 +638,7 @@ export const addChannel: AddWiring = (
     disconnect: disconnectFuncId ? { pikkuFuncId: disconnectFuncId } : null,
     message,
     messageWirings,
+    binary: binary === undefined ? undefined : binary,
     summary,
     description,
     errors,

package/src/add/add-cli.ts

@@ -7,7 +7,10 @@ import type {
   InspectorState,
 } from '../types.js'
 import type { CLIProgramMeta, CLICommandMeta } from '@pikku/core/cli'
-import { extractFunctionName } from '../utils/extract-function-name.js'
+import {
+  extractFunctionName,
+  makeContextBasedId,
+} from '../utils/extract-function-name.js'
 import { resolveMiddleware } from '../utils/middleware.js'
 import { extractWireNames } from '../utils/post-process.js'
 import { getPropertyValue } from '../utils/get-property-value.js'
@@ -153,14 +156,18 @@ function processCLIConfig(
         }
         break
 
-      case 'render':
-        // Extract the actual renderer function name
-        programMeta.defaultRenderName = extractFunctionName(
+      case 'render': {
+        let renderFuncId = extractFunctionName(
           prop.initializer,
           typeChecker,
           inspectorState.rootDir
         ).pikkuFuncId
+        if (renderFuncId.startsWith('__temp_')) {
+          renderFuncId = makeContextBasedId('cli-render', programName)
+        }
+        programMeta.defaultRenderName = renderFuncId
         break
+      }
     }
   }
 
@@ -273,12 +280,16 @@ function processCommand(
     ts.isArrowFunction(node) ||
     ts.isFunctionExpression(node)
   ) {
+    let pikkuFuncId = extractFunctionName(
+      node,
+      typeChecker,
+      inspectorState.rootDir
+    ).pikkuFuncId
+    if (pikkuFuncId.startsWith('__temp_')) {
+      pikkuFuncId = makeContextBasedId('cli', programName, ...fullPath)
+    }
     return {
-      pikkuFuncId: extractFunctionName(
-        node,
-        typeChecker,
-        inspectorState.rootDir
-      ).pikkuFuncId,
+      pikkuFuncId,
       positionals: [],
       options: {},
     }
@@ -338,6 +349,9 @@ function processCommand(
         typeChecker,
         inspectorState.rootDir
       ).pikkuFuncId
+      if (pikkuFuncId.startsWith('__temp_')) {
+        pikkuFuncId = makeContextBasedId('cli', programName, ...fullPath)
+      }
       meta.pikkuFuncId = pikkuFuncId
     } else if (
       propName === 'options' &&
@@ -393,13 +407,22 @@ function processCommand(
         // Already handled in first pass
         break
 
-      case 'render':
-        meta.renderName = extractFunctionName(
+      case 'render': {
+        let renderFuncId = extractFunctionName(
           prop.initializer,
           typeChecker,
           inspectorState.rootDir
         ).pikkuFuncId
+        if (renderFuncId.startsWith('__temp_')) {
+          renderFuncId = makeContextBasedId(
+            'cli-render',
+            programName,
+            ...fullPath
+          )
+        }
+        meta.renderName = renderFuncId
         break
+      }
 
       case 'options':
         // Process with pikkuFuncId from first pass

package/src/add/add-gateway.ts

@@ -0,0 +1,95 @@
+import * as ts from 'typescript'
+import {
+  getPropertyValue,
+  getCommonWireMetaData,
+} from '../utils/get-property-value.js'
+import type { AddWiring } from '../types.js'
+import {
+  extractFunctionName,
+  makeContextBasedId,
+} from '../utils/extract-function-name.js'
+import { getPropertyAssignmentInitializer } from '../utils/type-utils.js'
+import { resolveMiddleware } from '../utils/middleware.js'
+import { extractWireNames } from '../utils/post-process.js'
+import type { GatewayTransportType } from '@pikku/core/gateway'
+
+import { ErrorCode } from '../error-codes.js'
+
+export const addGateway: AddWiring = (
+  logger,
+  node,
+  checker,
+  state,
+  _options
+) => {
+  if (!ts.isCallExpression(node)) {
+    return
+  }
+
+  const args = node.arguments
+  const firstArg = args[0]
+  const expression = node.expression
+
+  if (!ts.isIdentifier(expression) || expression.text !== 'wireGateway') {
+    return
+  }
+
+  if (!firstArg || !ts.isObjectLiteralExpression(firstArg)) {
+    return
+  }
+
+  const obj = firstArg
+
+  const nameValue = getPropertyValue(obj, 'name') as string | null
+  const typeValue = getPropertyValue(obj, 'type') as GatewayTransportType | null
+  const routeValue = getPropertyValue(obj, 'route') as string | undefined
+  const { disabled, tags, summary, description, errors } =
+    getCommonWireMetaData(obj, 'Gateway', nameValue, logger)
+
+  if (disabled) return
+
+  const funcInitializer = getPropertyAssignmentInitializer(
+    obj,
+    'func',
+    true,
+    checker
+  )
+  if (!funcInitializer) {
+    logger.critical(
+      ErrorCode.MISSING_FUNC,
+      `No valid 'func' property for gateway '${nameValue}'.`
+    )
+    return
+  }
+
+  const extracted = extractFunctionName(funcInitializer, checker, state.rootDir)
+  let pikkuFuncId = extracted.pikkuFuncId
+  if (pikkuFuncId.startsWith('__temp_') && nameValue) {
+    pikkuFuncId = makeContextBasedId('gateway', nameValue)
+  }
+
+  if (!nameValue || !typeValue) {
+    return
+  }
+
+  const middleware = resolveMiddleware(state, obj, tags, checker)
+
+  state.serviceAggregation.usedFunctions.add(pikkuFuncId)
+  extractWireNames(middleware).forEach((name) =>
+    state.serviceAggregation.usedMiddleware.add(name)
+  )
+
+  state.gateways.files.add(node.getSourceFile().fileName)
+  state.gateways.meta[nameValue] = {
+    pikkuFuncId,
+    name: nameValue,
+    type: typeValue,
+    route: routeValue,
+    gateway: true,
+    summary,
+    description,
+    errors,
+    tags,
+    middleware,
+  }
+}

package/src/inspector.ts

@@ -83,6 +83,10 @@ export function getInitialInspectorState(rootDir: string): InspectorState {
       files: new Set(),
       meta: {},
     },
+    gateways: {
+      meta: {},
+      files: new Set(),
+    },
     triggers: {
       meta: {},
       sourceMeta: {},

package/src/types.ts

@@ -1,5 +1,6 @@
 import type * as ts from 'typescript'
 import type { ChannelsMeta } from '@pikku/core/channel'
+import type { GatewaysMeta } from '@pikku/core/gateway'
 import type { HTTPWiringsMeta } from '@pikku/core/http'
 import type { ScheduledTasksMeta } from '@pikku/core/scheduler'
 import type { TriggerMeta, TriggerSourceMeta } from '@pikku/core/trigger'
@@ -303,6 +304,10 @@ export interface InspectorState {
   http: InspectorHTTPState
   functions: InspectorFunctionState
   channels: InspectorChannelState
+  gateways: {
+    meta: GatewaysMeta
+    files: Set<string>
+  }
   triggers: {
     meta: TriggerMeta
     sourceMeta: TriggerSourceMeta

package/src/utils/serialize-inspector-state.ts

@@ -116,6 +116,10 @@ export interface SerializableInspectorState {
     files: string[]
     meta: InspectorState['channels']['meta']
   }
+  gateways: {
+    meta: InspectorState['gateways']['meta']
+    files: string[]
+  }
   triggers: {
     meta: InspectorState['triggers']['meta']
     sourceMeta: InspectorState['triggers']['sourceMeta']
@@ -315,6 +319,10 @@ export function serializeInspectorState(
       files: Array.from(state.channels.files),
       meta: state.channels.meta,
     },
+    gateways: {
+      meta: state.gateways.meta,
+      files: Array.from(state.gateways.files),
+    },
     triggers: {
       meta: state.triggers.meta,
       sourceMeta: state.triggers.sourceMeta,
@@ -479,6 +487,10 @@ export function deserializeInspectorState(
       files: new Set(data.channels.files),
       meta: data.channels.meta,
     },
+    gateways: {
+      meta: data.gateways?.meta ?? {},
+      files: new Set(data.gateways?.files ?? []),
+    },
     triggers: {
       meta: data.triggers?.meta ?? {},
       sourceMeta: data.triggers?.sourceMeta ?? {},

package/src/visit.ts

@@ -16,6 +16,7 @@ import type {
 } from './types.js'
 import { addFunctions } from './add/add-functions.js'
 import { addChannel } from './add/add-channel.js'
+import { addGateway } from './add/add-gateway.js'
 import { addRPCInvocations } from './add/add-rpc-invocations.js'
 import { addWireAddon } from './add/add-wire-addon.js'
 import { addMiddleware } from './add/add-middleware.js'
@@ -111,6 +112,7 @@ export const visitRoutes = (
   addTrigger(logger, node, checker, state, options)
   addQueueWorker(logger, node, checker, state, options)
   addChannel(logger, node, checker, state, options)
+  addGateway(logger, node, checker, state, options)
   addCLI(logger, node, checker, state, options)
   addCLIRenderers(logger, node, checker, state, options)
   addMCPResource(logger, node, checker, state, options)