@pikku/core 0.11.0 → 0.11.2

package/src/wirings/cli/cli-runner.test.ts

@@ -8,7 +8,7 @@ import { addFunction } from '../../function/function-runner.js'
 
 describe('CLI Runner', () => {
   let singletonServices: any
-  let createSessionServices: any
+  let createWireServices: any
 
   beforeEach(() => {
     resetPikkuState()
@@ -21,7 +21,7 @@ describe('CLI Runner', () => {
       },
     }
 
-    createSessionServices = async () => ({})
+    createWireServices = async () => ({})
   })
 
   afterEach(() => {
@@ -30,7 +30,7 @@ describe('CLI Runner', () => {
 
   describe('runCLICommand', () => {
     test('should throw NotFoundError when program not found', async () => {
-      pikkuState('cli', 'meta', { programs: {}, renderers: {} })
+      pikkuState(null, 'cli', 'meta', { programs: {}, renderers: {} })
 
       await assert.rejects(
         async () =>
@@ -45,7 +45,7 @@ describe('CLI Runner', () => {
     })
 
     test('should throw NotFoundError when command not found', async () => {
-      pikkuState('cli', 'meta', {
+      pikkuState(null, 'cli', 'meta', {
         programs: {
           'test-cli': {
             program: 'test-cli',
@@ -56,7 +56,7 @@ describe('CLI Runner', () => {
         renderers: {},
       })
 
-      pikkuState('cli', 'programs', {
+      pikkuState(null, 'cli', 'programs', {
         'test-cli': {
           defaultRenderer: undefined,
           middleware: [],
@@ -78,13 +78,13 @@ describe('CLI Runner', () => {
 
     test('should execute command function with merged data', async () => {
       let receivedData: any
-      const testFunc = async (_services: any, data: any) => {
+      const testFunc = async (_services: any, data: any, _wire: any) => {
         receivedData = data
         return { success: true }
       }
 
       // Setup metadata
-      pikkuState('cli', 'meta', {
+      pikkuState(null, 'cli', 'meta', {
         programs: {
           'test-cli': {
             program: 'test-cli',
@@ -102,7 +102,7 @@ describe('CLI Runner', () => {
         renderers: {},
       })
 
-      pikkuState('cli', 'programs', {
+      pikkuState(null, 'cli', 'programs', {
         'test-cli': {
           defaultRenderer: undefined,
           middleware: [],
@@ -110,7 +110,7 @@ describe('CLI Runner', () => {
         },
       })
 
-      pikkuState('function', 'meta', {
+      pikkuState(null, 'function', 'meta', {
         greetFunc: {
           pikkuFuncName: 'greetFunc',
           inputSchemaName: null,
@@ -136,7 +136,7 @@ describe('CLI Runner', () => {
 
       const testMiddleware: CorePikkuMiddleware = async (
         _services,
-        _interaction,
+        _wire,
         next
       ) => {
         executionOrder.push('middleware')
@@ -148,7 +148,7 @@ describe('CLI Runner', () => {
         return { success: true }
       }
 
-      pikkuState('cli', 'meta', {
+      pikkuState(null, 'cli', 'meta', {
         programs: {
           'test-cli': {
             program: 'test-cli',
@@ -166,7 +166,7 @@ describe('CLI Runner', () => {
         renderers: {},
       })
 
-      pikkuState('cli', 'programs', {
+      pikkuState(null, 'cli', 'programs', {
         'test-cli': {
           defaultRenderer: undefined,
           middleware: [testMiddleware],
@@ -174,7 +174,7 @@ describe('CLI Runner', () => {
         },
       })
 
-      pikkuState('function', 'meta', {
+      pikkuState(null, 'function', 'meta', {
         testFunc: {
           pikkuFuncName: 'testFunc',
           inputSchemaName: null,
@@ -199,16 +199,16 @@ describe('CLI Runner', () => {
 
       const testMiddleware: CorePikkuMiddleware = async (
         _services,
-        interaction,
+        wire,
         next
       ) => {
-        cliContext = interaction.cli
+        cliContext = wire.cli
         await next()
       }
 
       const testFunc = async () => ({ success: true })
 
-      pikkuState('cli', 'meta', {
+      pikkuState(null, 'cli', 'meta', {
         programs: {
           'test-cli': {
             program: 'test-cli',
@@ -226,7 +226,7 @@ describe('CLI Runner', () => {
         renderers: {},
       })
 
-      pikkuState('cli', 'programs', {
+      pikkuState(null, 'cli', 'programs', {
         'test-cli': {
           defaultRenderer: undefined,
           middleware: [testMiddleware],
@@ -234,7 +234,7 @@ describe('CLI Runner', () => {
         },
       })
 
-      pikkuState('function', 'meta', {
+      pikkuState(null, 'function', 'meta', {
         greetFunc: {
           pikkuFuncName: 'greetFunc',
           inputSchemaName: null,
@@ -260,7 +260,7 @@ describe('CLI Runner', () => {
     test('should throw error when auth required but no session', async () => {
       const testFunc = async () => ({ success: true })
 
-      pikkuState('cli', 'meta', {
+      pikkuState(null, 'cli', 'meta', {
         programs: {
           'test-cli': {
             program: 'test-cli',
@@ -278,7 +278,7 @@ describe('CLI Runner', () => {
         renderers: {},
       })
 
-      pikkuState('function', 'meta', {
+      pikkuState(null, 'function', 'meta', {
         secureFunc: {
           pikkuFuncName: 'secureFunc',
           inputSchemaName: null,
@@ -295,7 +295,7 @@ describe('CLI Runner', () => {
             commandPath: ['secure'],
             data: {},
             singletonServices,
-            createSessionServices,
+            createWireServices,
           }),
         /Authentication required/
       )
@@ -306,7 +306,7 @@ describe('CLI Runner', () => {
     test('should register CLI program and commands', () => {
       const greetFunc = async () => 'Hello'
 
-      pikkuState('cli', 'meta', {
+      pikkuState(null, 'cli', 'meta', {
         programs: {
           'my-cli': {
             program: 'my-cli',
@@ -337,7 +337,7 @@ describe('CLI Runner', () => {
         },
       })
 
-      const programs = pikkuState('cli', 'programs')
+      const programs = pikkuState(null, 'cli', 'programs')
       assert.ok(programs['my-cli'])
       assert.strictEqual(programs['my-cli'].middleware.length, 0)
     })
@@ -347,7 +347,7 @@ describe('CLI Runner', () => {
         await next()
       }
 
-      pikkuState('cli', 'meta', {
+      pikkuState(null, 'cli', 'meta', {
         programs: {
           'my-cli': {
             program: 'my-cli',
@@ -364,13 +364,13 @@ describe('CLI Runner', () => {
         middleware: [middleware],
       })
 
-      const programs = pikkuState('cli', 'programs')
+      const programs = pikkuState(null, 'cli', 'programs')
       assert.strictEqual(programs['my-cli'].middleware.length, 1)
       assert.strictEqual(programs['my-cli'].middleware[0], middleware)
     })
 
     test('should throw error when CLI metadata not found', () => {
-      pikkuState('cli', 'meta', { programs: {}, renderers: {} })
+      pikkuState(null, 'cli', 'meta', { programs: {}, renderers: {} })
 
       assert.throws(() => {
         wireCLI({

package/src/wirings/cli/cli-runner.ts

@@ -1,13 +1,7 @@
 import { NotFoundError } from '../../errors/errors.js'
 import { addFunction, runPikkuFunc } from '../../function/function-runner.js'
 import { pikkuState } from '../../pikku-state.js'
-import {
-  CorePikkuMiddleware,
-  CoreUserSession,
-  SessionServices,
-  PikkuWiringTypes,
-} from '../../types/core.types.js'
-import { closeSessionServices } from '../../utils.js'
+import { CorePikkuMiddleware, CoreUserSession } from '../../types/core.types.js'
 import {
   CoreCLI,
   CLICommandMeta,
@@ -20,14 +14,13 @@ import {
 import type {
   CoreSingletonServices,
   CoreServices,
-  CreateSessionServices,
-  PikkuInteraction,
+  CreateWireServices,
+  PikkuWire,
   CreateConfig,
   CreateSingletonServices,
 } from '../../types/core.types.js'
 import { PikkuChannel } from '../channel/channel.types.js'
-import { rpcService } from '../rpc/rpc-runner.js'
-import { PikkuUserSessionService } from '../../services/user-session-service.js'
+import { PikkuSessionService } from '../../services/user-session-service.js'
 import { LocalVariablesService } from '../../services/local-variables.js'
 import { generateCommandHelp, parseCLIArguments } from './command-parser.js'
 
@@ -64,7 +57,7 @@ export const wireCLI = <
   cli: CoreCLI<Commands, GlobalOptions, PikkuMiddleware, GlobalOutput>
 ) => {
   // Get the existing metadata that was generated during inspection
-  const cliMeta = pikkuState('cli', 'meta') || {}
+  const cliMeta = pikkuState(null, 'cli', 'meta') || {}
 
   if (!cliMeta.programs?.[cli.program]) {
     throw new Error(
@@ -74,7 +67,7 @@ export const wireCLI = <
 
   // Get existing programs state and add this program
   const programs: Record<string, CLIProgramState> =
-    pikkuState('cli', 'programs') || {}
+    pikkuState(null, 'cli', 'programs') || {}
   programs[cli.program] = {
     defaultRenderer: (cli.render ||
       defaultJSONRenderer) as CorePikkuCLIRender<any>,
@@ -82,7 +75,7 @@ export const wireCLI = <
     renderers: {},
     tags: cli.tags,
   }
-  pikkuState('cli', 'programs', programs)
+  pikkuState(null, 'cli', 'programs', programs)
 
   // Register all command functions recursively
   registerCLICommands(
@@ -137,7 +130,7 @@ function registerCLICommands(
   program: string
 ) {
   // Get the CLI metadata to find actual function names
-  const cliMeta = pikkuState('cli', 'meta').programs[program]
+  const cliMeta = pikkuState(null, 'cli', 'meta').programs[program]
 
   for (const [name, command] of Object.entries(commands)) {
     const fullPath = [...path, name]
@@ -173,6 +166,7 @@ function registerCLICommands(
 
     // Store the options and middleware in program state for use during execution
     const programs: Record<string, CLIProgramState> = pikkuState(
+      null,
       'cli',
       'programs'
     )
@@ -215,10 +209,10 @@ function pluckCLIData(
   funcName: string,
   availableOptions: Record<string, CLIOption>
 ): Record<string, any> {
-  const funcMeta = pikkuState('function', 'meta')[funcName]
+  const funcMeta = pikkuState(null, 'function', 'meta')[funcName]
   const schemaName = funcMeta?.inputSchemaName
   const schema = schemaName
-    ? pikkuState('misc', 'schemas').get(schemaName)
+    ? pikkuState(null, 'misc', 'schemas').get(schemaName)
     : null
 
   if (schema && schema.properties) {
@@ -247,16 +241,16 @@ export async function runCLICommand({
   commandPath,
   data,
   singletonServices,
-  createSessionServices,
+  createWireServices,
 }: {
   program: string
   commandPath: string[]
   data: Record<string, any>
   singletonServices: CoreSingletonServices
-  createSessionServices?: CreateSessionServices
+  createWireServices?: CreateWireServices
 }): Promise<any> {
   // Get the command metadata to find the function name
-  const cliMeta = pikkuState('cli', 'meta')
+  const cliMeta = pikkuState(null, 'cli', 'meta')
   const programMeta = cliMeta.programs?.[program]
   if (!programMeta) {
     throw new NotFoundError(`Program not found: ${program}`)
@@ -282,7 +276,7 @@ export async function runCLICommand({
 
   // Get program-specific data
   const programs: Record<string, CLIProgramState> =
-    pikkuState('cli', 'programs') || {}
+    pikkuState(null, 'cli', 'programs') || {}
   const programData = programs[program]
 
   // Combine program middleware + command middleware from the hierarchy
@@ -329,57 +323,31 @@ export async function runCLICommand({
     state: 'open',
   }
 
-  const userSession = new PikkuUserSessionService<CoreUserSession>()
-  let sessionServices: SessionServices | undefined
+  const userSession = new PikkuSessionService<CoreUserSession>()
 
-  const interaction: PikkuInteraction = {
+  const wire: PikkuWire = {
     cli: {
       program,
       command: commandPath,
       data: pluckedData,
       channel,
     },
-  }
-
-  const getAllServices = async (session?: CoreUserSession) => {
-    // Create session-specific services for handling the command
-    sessionServices = await createSessionServices?.(
-      singletonServices,
-      interaction,
-      session
-    )
-
-    return rpcService.injectRPCService(
-      {
-        ...singletonServices,
-        ...sessionServices,
-        userSession,
-        channel,
-      },
-      interaction,
-      false
-    )
+    session: userSession,
   }
 
   try {
-    const result = await runPikkuFunc(
-      PikkuWiringTypes.cli,
-      commandId,
-      funcName,
-      {
-        singletonServices,
-        getAllServices,
-        data: pluckedData,
-        auth: false,
-        userSession,
-        inheritedMiddleware: currentCommand.middleware,
-        wireMiddleware: allWireMiddleware,
-        inheritedPermissions: currentCommand.permissions,
-        wirePermissions: undefined,
-        tags: programData?.tags,
-        interaction,
-      }
-    )
+    const result = await runPikkuFunc('cli', commandId, funcName, {
+      singletonServices,
+      createWireServices,
+      data: pluckedData,
+      auth: false,
+      inheritedMiddleware: currentCommand.middleware,
+      wireMiddleware: allWireMiddleware,
+      inheritedPermissions: currentCommand.permissions,
+      wirePermissions: undefined,
+      tags: programData?.tags,
+      wire,
+    })
 
     // Apply renderer one final time with the final output (if renderer exists)
     if (renderer) {
@@ -392,11 +360,6 @@ export async function runCLICommand({
   } finally {
     // Close the channel
     channel.close()
-
-    // Clean up session services
-    if (sessionServices) {
-      await closeSessionServices(singletonServices.logger, sessionServices)
-    }
   }
 }
 
@@ -428,13 +391,13 @@ export async function executeCLI({
   args,
   createConfig,
   createSingletonServices,
-  createSessionServices,
+  createWireServices,
 }: {
   programName: string
   args?: string[]
   createConfig: CreateConfig<any, any>
   createSingletonServices: CreateSingletonServices<any, any>
-  createSessionServices?: CreateSessionServices<any, any, any>
+  createWireServices?: CreateWireServices<any, any, any>
 }): Promise<void> {
   if (!args) {
     throw new Error(
@@ -444,7 +407,7 @@ export async function executeCLI({
 
   try {
     // Get CLI metadata from state
-    const allCLIMeta = pikkuState('cli', 'meta') as unknown as
+    const allCLIMeta = pikkuState(null, 'cli', 'meta') as unknown as
       | CLIMeta
       | undefined
     if (!allCLIMeta) {
@@ -518,7 +481,7 @@ export async function executeCLI({
       commandPath: parsed.commandPath,
       data,
       singletonServices,
-      createSessionServices,
+      createWireServices,
     })
   } catch (error: any) {
     // Re-throw CLIError as-is

package/src/wirings/cli/cli.types.ts

@@ -2,7 +2,6 @@ import {
   CorePikkuMiddleware,
   CoreSingletonServices,
   CoreUserSession,
-  PikkuDocs,
   CoreServices,
   MiddlewareMetadata,
   PermissionMetadata,
@@ -44,7 +43,7 @@ export interface CLIPositional {
 }
 
 /**
- * CLI interaction context
+ * CLI wire context
  */
 export type PikkuCLI = {
   program: string
@@ -74,8 +73,9 @@ export interface CLICommandMeta {
   positionals: CLIPositional[]
   options: Record<string, CLIOption>
   renderName?: string
+  summary?: string
   description?: string
-  docs?: PikkuDocs
+  errors?: string[]
   tags?: string[]
   subcommands?: Record<string, CLICommandMeta>
   middleware?: MiddlewareMetadata[] // Pre-resolved middleware chain (tag + explicit)
@@ -131,8 +131,8 @@ export type CorePikkuCLIRender<
 export type ExtractFunctionInput<Func> =
   Func extends CorePikkuFunctionConfig<infer FuncType, any, any>
     ? FuncType extends
-        | CorePikkuFunction<infer Input, any, any, any, any>
-        | CorePikkuFunctionSessionless<infer Input, any, any, any, any>
+        | CorePikkuFunction<infer Input, any, any, any>
+        | CorePikkuFunctionSessionless<infer Input, any, any, any>
       ? Input
       : never
     : never
@@ -198,8 +198,8 @@ export type ValidateParameters<Params extends string, Input> =
 export type ExtractFunctionOutput<Func> =
   Func extends CorePikkuFunctionConfig<infer FuncType, any, any>
     ? FuncType extends
-        | CorePikkuFunction<any, infer Output, any, any, any>
-        | CorePikkuFunctionSessionless<any, infer Output, any, any, any>
+        | CorePikkuFunction<any, infer Output, any, any>
+        | CorePikkuFunctionSessionless<any, infer Output, any, any>
       ? Output
       : never
     : never
@@ -210,7 +210,10 @@ export type ExtractFunctionOutput<Func> =
  */
 export type CoreCLICommandConfig<
   FuncConfig,
-  PikkuMiddleware extends CorePikkuMiddleware<any> = CorePikkuMiddleware<any>,
+  PikkuMiddleware extends CorePikkuMiddleware<any, any> = CorePikkuMiddleware<
+    any,
+    any
+  >,
   PikkuCLIRender extends CorePikkuCLIRender<any, any, any> = CorePikkuCLIRender<
     any,
     any
@@ -219,6 +222,7 @@ export type CoreCLICommandConfig<
 > = {
   parameters?: ValidateParameters<Params, ExtractFunctionInput<FuncConfig>>
   func?: FuncConfig
+  title?: string
   description?: string
   render?: PikkuCLIRender
   options?: {
@@ -245,8 +249,8 @@ export interface CoreCLICommand<
   In,
   Out,
   PikkuFunctionConfig extends CorePikkuFunctionConfig<
-    | CorePikkuFunction<In, Out, any, any, any>
-    | CorePikkuFunctionSessionless<In, Out, any, any, any>
+    | CorePikkuFunction<In, Out, any, any>
+    | CorePikkuFunctionSessionless<In, Out, any, any>
   >,
   PikkuPermission extends CorePikkuPermission<any, any, any>,
   PikkuMiddleware extends CorePikkuMiddleware,
@@ -264,7 +268,9 @@ export interface CoreCLICommand<
   middleware?: PikkuMiddleware[]
   permissions?: Record<string, PikkuPermission | PikkuPermission[]>
   auth?: boolean
-  docs?: PikkuDocs
+  summary?: string
+  errors?: string[]
+  tags?: string[]
   subcommands?: Subcommands
   isDefault?: boolean
 }
@@ -276,8 +282,8 @@ export type CLICommandShorthand<
   In,
   Out,
   PikkuFunctionConfig extends CorePikkuFunctionConfig<
-    | CorePikkuFunction<In, Out, any, any, any>
-    | CorePikkuFunctionSessionless<In, Out, any, any, any>
+    | CorePikkuFunction<In, Out, any, any>
+    | CorePikkuFunctionSessionless<In, Out, any, any>
   >,
 > = PikkuFunctionConfig
 
@@ -288,8 +294,8 @@ export type CLICommandDefinition<
   In,
   Out,
   PikkuFunctionConfig extends CorePikkuFunctionConfig<
-    | CorePikkuFunction<In, Out, any, any, any>
-    | CorePikkuFunctionSessionless<In, Out, any, any, any>
+    | CorePikkuFunction<In, Out, any, any>
+    | CorePikkuFunctionSessionless<In, Out, any, any>
   >,
   PikkuPermission extends CorePikkuPermission<any, any, any>,
   PikkuMiddleware extends CorePikkuMiddleware,
@@ -325,7 +331,8 @@ export interface CoreCLI<
   options?: CLIOptions<Options>
   middleware?: PikkuMiddleware[]
   render?: PikkuCLIRender
-  docs?: PikkuDocs
+  summary?: string
+  errors?: string[]
   tags?: string[]
 }