@pikku/cli 0.9.15 → 0.10.0

package/.pikku/channel/pikku-channel-types.gen.ts

@@ -0,0 +1,91 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+/**
+
+ * Channel-specific type definitions for tree-shaking optimization
+ */
+
+import { CoreChannel, wireChannel as wireChannelCore } from '@pikku/core/channel'
+import { CorePikkuFunctionConfig } from '@pikku/core'
+import { AssertHTTPWiringParams } from '@pikku/core/http'
+import type { PikkuFunctionSessionless, PikkuPermission, PikkuMiddleware } from '../function/pikku-function-types.gen.js'
+
+/**
+ * Type definition for WebSocket channels with typed data exchange.
+ * Supports connection, disconnection, and message handling.
+ *
+ * @template ChannelData - Type of data exchanged through the channel
+ * @template Channel - String literal type for the channel name
+ */
+type ChannelWiring<ChannelData, Channel extends string> = CoreChannel<
+  ChannelData,
+  Channel,
+  CorePikkuFunctionConfig<PikkuFunctionSessionless<void, any, ChannelData>, PikkuPermission<void>, PikkuMiddleware>,
+  CorePikkuFunctionConfig<PikkuFunctionSessionless<void, void, ChannelData>, PikkuPermission<void>, PikkuMiddleware>,
+  CorePikkuFunctionConfig<PikkuFunctionSessionless<any, any, ChannelData>, PikkuPermission<any>, PikkuMiddleware>,
+  PikkuPermission,
+  PikkuMiddleware
+>
+
+/**
+ * Creates a function that handles WebSocket channel connections.
+ * Called when a client connects to a channel.
+ *
+ * @template Out - Output type for connection response
+ * @param func - Function definition, either direct function or configuration object
+ * @returns The normalized configuration object
+ */
+export const pikkuChannelConnectionFunc = <Out = unknown>(
+  func:
+    | PikkuFunctionSessionless<void, Out, unknown>
+    | CorePikkuFunctionConfig<PikkuFunctionSessionless<void, Out, unknown>, PikkuPermission<void>, PikkuMiddleware>
+) => {
+  return typeof func === 'function' ? { func } : func
+}
+
+/**
+ * Creates a function that handles WebSocket channel disconnections.
+ * Called when a client disconnects from a channel.
+ *
+ * @param func - Function definition, either direct function or configuration object
+ * @returns The normalized configuration object
+ */
+export const pikkuChannelDisconnectionFunc = (
+  func:
+    | PikkuFunctionSessionless<void, void, unknown>
+    | CorePikkuFunctionConfig<PikkuFunctionSessionless<void, void, unknown>, PikkuPermission<void>, PikkuMiddleware>
+) => {
+  return typeof func === 'function' ? { func } : func
+}
+
+/**
+ * Creates a function that handles WebSocket channel messages.
+ * Called when a message is received on a channel.
+ * This is the same as pikkuSessionlessFunc but with ChannelData = unknown by default.
+ *
+ * @template In - Input type for channel messages
+ * @template Out - Output type for channel responses
+ * @param func - Function definition, either direct function or configuration object
+ * @returns The normalized configuration object
+ */
+export const pikkuChannelFunc = <In, Out = unknown>(
+  func:
+    | PikkuFunctionSessionless<In, Out, unknown>
+    | CorePikkuFunctionConfig<PikkuFunctionSessionless<In, Out, unknown>, PikkuPermission<In>, PikkuMiddleware>
+) => {
+  return typeof func === 'function' ? { func } : func
+}
+
+/**
+ * Registers a WebSocket channel with the Pikku framework.
+ *
+ * @template ChannelData - Type of data associated with the channel
+ * @template Channel - String literal type for the channel name
+ * @param channel - Channel definition with connection, disconnection, and message handlers
+ */
+export const wireChannel = <ChannelData, Channel extends string>(
+  channel: ChannelWiring<ChannelData, Channel> & AssertHTTPWiringParams<ChannelData, Channel>
+) => {
+  wireChannelCore(channel as any) // TODO
+}

package/.pikku/channel/pikku-channels-map.gen.d.ts

@@ -0,0 +1,44 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+/**
+ * This provides the structure needed for TypeScript to be aware of channels
+ */
+    
+
+
+// Custom types are those that are defined directly within generics
+// or are broken into simpler types
+export type PikkuSchemasOutput = false | true
+export type PikkuChannelsOutput = false | true
+export type PikkuCLIOutput = false | true
+export type PikkuFunctionsOutput = false | true
+export type PikkuHTTPOutput = false | true
+export type PikkuMCPOutput = false | true
+export type PikkuMiddlewareOutput = false | true
+export type PikkuPermissionsOutput = false | true
+export type PikkuQueueOutput = false | true
+export type PikkuRPCOutput = false | true
+export type PikkuSchedulerOutput = false | true
+
+interface ChannelHandler<I, O> {
+    input: I;
+    output: O;
+}
+
+export type ChannelsMap = {
+};
+
+export type ChannelDefaultHandlerOf<Channel extends keyof ChannelsMap> =
+    ChannelsMap[Channel]['defaultMessage'] extends { input: infer I; output: infer O }
+        ? ChannelHandler<I, O>
+        : never;
+
+export type ChannelWiringHandlerOf<
+    Channel extends keyof ChannelsMap, 
+    Route extends keyof ChannelsMap[Channel]['routes'], 
+    Method extends keyof ChannelsMap[Channel]['routes'][Route],
+> =
+    ChannelsMap[Channel]['routes'][Route][Method] extends { input: infer I; output: infer O }
+        ? ChannelHandler<I, O>
+        : never;

package/.pikku/channel/pikku-channels-meta.gen.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+import { pikkuState } from '@pikku/core'
+pikkuState('channel', 'meta', {})

package/.pikku/channel/pikku-channels.gen.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+/* The files with an addChannel function call */

package/.pikku/cli/pikku-cli-channel.gen.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+/**
+ * WebSocket channel backend for 'pikku' CLI commands
+ */
+import { wireChannel } from '../channel/pikku-channel-types.gen.js'
+import { all } from '../../src/functions/commands/all.js'
+import { pikkuSchemas } from '../../src/functions/wirings/functions/schemas.js'
+import { pikkuFetch } from '../../src/functions/wirings/fetch/index.js'
+import { pikkuWebSocketTyped } from '../../src/functions/wirings/channels/pikku-command-websocket-typed.js'
+import { pikkuRPCClient } from '../../src/functions/wirings/rpc/pikku-command-rpc-client.js'
+import { pikkuQueueService } from '../../src/functions/wirings/queue/pikku-command-queue-service.js'
+import { pikkuOpenAPI } from '../../src/functions/wirings/http/pikku-command-openapi.js'
+import { pikkuNext } from '../../src/functions/runtimes/nextjs/pikku-command-nextjs.js'
+
+wireChannel({
+  name: 'pikku-cli',
+  route: '/cli/pikku',
+  auth: false,
+  onMessageWiring: {
+    command: {
+      'all': all,
+      'schemas': pikkuSchemas,
+      'fetch': pikkuFetch,
+      'websocket': pikkuWebSocketTyped,
+      'rpc': pikkuRPCClient,
+      'queue-service': pikkuQueueService,
+      'openapi': pikkuOpenAPI,
+      'nextjs': pikkuNext
+    }
+  },
+  tags: ['cli', 'pikku']
+})

package/.pikku/cli/pikku-cli-client.gen.ts

@@ -0,0 +1,43 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+
+import { executeCLIViaChannel } from '@pikku/core/cli/channel'
+import { CorePikkuWebsocket } from '@pikku/websocket'
+import '../pikku-bootstrap.gen.js'
+import { clientCLIRenderer } from '../../src/services.js'
+
+/**
+ * Pikku CLI Client (via WebSocket Channel)
+ * Executes CLI commands over a WebSocket connection
+ */
+export async function PikkuCLIClient(
+  url: string,
+  args?: string[]
+): Promise<void> {
+  // Create WebSocket connection
+  const pikkuWS = new CorePikkuWebsocket(url)
+
+  // Register renderers for CLI commands
+  const renderers = {}
+
+  await executeCLIViaChannel({
+    programName: 'pikku',
+    pikkuWS,
+    args,
+    renderers,
+    defaultRenderer: clientCLIRenderer,
+  })
+}
+
+// Export as default for easy importing
+export default PikkuCLIClient
+
+// For direct execution (if this file is run directly)
+if (import.meta.url === `file://${process.argv[1]}`) {
+  const url = process.env.PIKKU_WS_URL || 'ws://localhost:3000/cli/pikku'
+  PikkuCLIClient(url, process.argv.slice(2)).catch(error => {
+    console.error('Fatal error:', error.message)
+    process.exit(1)
+  })
+}

package/.pikku/cli/pikku-cli-types.gen.ts

@@ -0,0 +1,70 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+/**
+
+ * CLI-specific type definitions for tree-shaking optimization
+ */
+
+import { CoreCLI, wireCLI as wireCLICore, CorePikkuCLIRender, CoreCLICommandConfig } from '@pikku/core/cli'
+import type { PikkuFunctionConfig, PikkuMiddleware } from '../function/pikku-function-types.gen.js'
+import type { UserSession } from '../../types/application-types.d.js'
+import type { SingletonServices } from '../../types/application-types.d.js'
+
+
+type Session = UserSession
+
+/**
+ * Type-safe CLI renderer definition that can access your application's services.
+ * Use this to define custom renderers for CLI command output.
+ *
+ * @template Data - The output data type from the CLI command
+ * @template RequiredServices - The services required for this renderer
+ */
+type PikkuCLIRender<Data, RequiredServices extends SingletonServices = SingletonServices> = CorePikkuCLIRender<Data, RequiredServices, Session>
+
+/**
+ * CLI command configuration with project-specific types.
+ * Uses CoreCLICommandConfig from @pikku/core with local middleware and render types.
+ */
+type CLICommandConfig<Func extends PikkuFunctionConfig<In, Out>, In = any, Out = any, Params extends string = string> = CoreCLICommandConfig<Func, PikkuMiddleware, PikkuCLIRender<any>, Params>
+
+/**
+ * Type definition for CLI applications with commands and global options.
+ *
+ * @template Commands - Type describing the command structure
+ * @template GlobalOptions - Type for global CLI options
+ */
+type CLIWiring<Commands extends Record<string, CoreCLICommandConfig<any, PikkuMiddleware, PikkuCLIRender<any>, any>>, GlobalOptions> = CoreCLI<Commands, GlobalOptions, PikkuMiddleware, PikkuCLIRender<any>>
+
+/**
+ * Registers a CLI application with the Pikku framework.
+ * Creates command-line interfaces with type-safe commands and options.
+ *
+ * @template Commands - Type describing the command structure
+ * @template GlobalOptions - Type for global CLI options
+ * @param cli - CLI definition with program name, commands, and global options
+ */
+export const wireCLI = <Commands extends Record<string, CoreCLICommandConfig<any, PikkuMiddleware, PikkuCLIRender<any>, any>>, GlobalOptions>(
+  cli: CLIWiring<Commands, GlobalOptions>
+) => {
+  wireCLICore(cli as any)
+}
+
+/**
+ * Creates a CLI command definition with automatic option inference from the function's input type.
+ * This allows TypeScript to automatically derive CLI options from the function signature.
+ *
+ * @template FuncConfig - The Pikku function config type
+ * @template Params - The parameters string literal type
+ * @param config - CLI command configuration
+ * @returns CLI command configuration with inferred types
+ */
+export const pikkuCLICommand = <
+  FuncConfig extends PikkuFunctionConfig<any, any>,
+  Params extends string
+>(
+  config: CLICommandConfig<FuncConfig, any, any, Params>
+): CoreCLICommandConfig<FuncConfig, PikkuMiddleware, PikkuCLIRender<any>, string> => {
+  return config as any
+}

package/.pikku/cli/pikku-cli-wirings-meta.gen.ts

@@ -0,0 +1,145 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+import { pikkuState } from '@pikku/core'
+pikkuState('cli', 'meta', {
+  "programs": {
+    "pikku": {
+      "program": "pikku",
+      "commands": {
+        "all": {
+          "pikkuFuncName": "all",
+          "positionals": [],
+          "options": {
+            "tags": {
+              "description": "Filter functions by tags (comma-separated)",
+              "short": "t"
+            },
+            "types": {
+              "description": "Filter functions by types (comma-separated)"
+            },
+            "directories": {
+              "description": "Filter functions by directories (comma-separated)",
+              "short": "d"
+            },
+            "httpMethods": {
+              "description": "Filter HTTP routes by methods (comma-separated)"
+            },
+            "httpRoutes": {
+              "description": "Filter HTTP routes by route patterns (comma-separated)"
+            },
+            "names": {
+              "description": "Filter functions by name patterns (supports wildcards)",
+              "short": "n"
+            }
+          },
+          "description": "Generate all Pikku files (types, schemas, wirings, etc.)",
+          "isDefault": true
+        },
+        "schemas": {
+          "pikkuFuncName": "pikkuSchemas",
+          "positionals": [],
+          "options": {},
+          "description": "Generate JSON schemas for function input/output types"
+        },
+        "fetch": {
+          "pikkuFuncName": "pikkuFetch",
+          "positionals": [],
+          "options": {},
+          "description": "Generate type-safe HTTP fetch client"
+        },
+        "websocket": {
+          "pikkuFuncName": "pikkuWebSocketTyped",
+          "positionals": [],
+          "options": {},
+          "description": "Generate type-safe WebSocket client"
+        },
+        "rpc": {
+          "pikkuFuncName": "pikkuRPCClient",
+          "positionals": [],
+          "options": {},
+          "description": "Generate RPC client wrappers"
+        },
+        "queue-service": {
+          "pikkuFuncName": "pikkuQueueService",
+          "positionals": [],
+          "options": {},
+          "description": "Generate queue service wrapper"
+        },
+        "openapi": {
+          "pikkuFuncName": "pikkuOpenAPI",
+          "positionals": [],
+          "options": {},
+          "description": "Generate OpenAPI specification from HTTP routes"
+        },
+        "nextjs": {
+          "pikkuFuncName": "pikkuNext",
+          "positionals": [],
+          "options": {},
+          "description": "Generate Next.js backend and HTTP wrappers"
+        }
+      },
+      "options": {
+        "config": {
+          "description": "Path to pikku.config.json file",
+          "short": "c"
+        },
+        "logLevel": {
+          "description": "Set log level",
+          "short": "l",
+          "choices": [
+            "trace",
+            "debug",
+            "info",
+            "warn",
+            "error",
+            "critical"
+          ]
+        },
+        "userSessionType": {
+          "description": "Specify which UserSession type to use (when multiple exist)"
+        },
+        "singletonServicesFactoryType": {
+          "description": "Specify which singleton services factory to use"
+        },
+        "sessionServicesFactoryType": {
+          "description": "Specify which session services factory to use"
+        },
+        "stateOutput": {
+          "description": "Save inspector state to JSON file for reuse"
+        },
+        "stateInput": {
+          "description": "Load inspector state from JSON file (skips inspection)"
+        }
+      },
+      "defaultRenderName": "clientCLIRenderer"
+    }
+  },
+  "renderers": {
+    "defaultCLIRenderer": {
+      "name": "defaultCLIRenderer",
+      "exportedName": "defaultCLIRenderer",
+      "services": {
+        "optimized": true,
+        "services": [
+          "logger",
+          "getInspectorState",
+          "schema",
+          "jwt",
+          "config",
+          "variables"
+        ]
+      },
+      "filePath": "/home/runner/work/pikku/pikku/packages/cli/src/services.ts"
+    },
+    "clientCLIRenderer": {
+      "name": "clientCLIRenderer",
+      "exportedName": "clientCLIRenderer",
+      "services": {
+        "optimized": true,
+        "services": []
+      },
+      "filePath": "/home/runner/work/pikku/pikku/packages/cli/src/services.ts"
+    }
+  }
+})

package/.pikku/cli/pikku-cli-wirings.gen.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+/* The files with an wireCLI function call */
+import '../../src/services.js'
+import '../../src/cli.wiring.js'

package/.pikku/cli/pikku-cli.gen.ts

@@ -0,0 +1,41 @@
+/**
+ * This file was generated by @pikku/cli@0.10.0
+ */
+
+import { executeCLI, CLIError } from '@pikku/core/cli'
+import { createConfig as createConfig } from '../../src/services.js'
+import { createSingletonServices as createSingletonServices } from '../../src/services.js'
+import { createSessionServices as createSessionServices } from '../../src/services.js'
+import '../pikku-bootstrap.gen.js'
+
+/**
+ * Pikku CLI function
+ * Handles command line arguments and executes the appropriate function
+ */
+export async function PikkuCLI(args: string[]): Promise<void> {
+  try {
+    await executeCLI({
+      programName: 'pikku',
+      args: args || process.argv.slice(2),
+      createConfig,
+      createSingletonServices,
+      createSessionServices,
+    })
+  } catch (error) {
+    if (error instanceof CLIError) {
+      process.exit(error.exitCode)
+    }
+    throw error
+  }
+}
+
+// Export as default for easy importing
+export default PikkuCLI
+
+// For direct execution (if this file is run directly)
+if (import.meta.url === `file://${process.argv[1]}`) {
+  PikkuCLI(process.argv.slice(2)).catch(error => {
+    console.error('Fatal error:', error.message)
+    process.exit(1)
+  })
+}