@pikku/cli 0.11.3 → 0.12.0

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

@@ -1,92 +0,0 @@
-/**
- * This file was generated by @pikku/cli@0.11.3
- */
-/**
-
- * 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>
-
-/**
- * Creates a type-safe CLI renderer with access to your application's singleton services.
- * The renderer receives the full singleton services and output data to format and display results.
- *
- * @template Data - The output data type from the CLI command
- * @template RequiredServices - The minimum services required for type checking (defaults to SingletonServices)
- * @param render - Function that receives singleton services and data to render output
- * @returns A CLI renderer configuration
- *
- * @example
- * ```typescript
- * const myRenderer = pikkuCLIRender<MyData>(({ logger }, data) => {
- *   logger.info(data.message)
- * })
- * ```
- */
-export const pikkuCLIRender = <Data, RequiredServices extends SingletonServices = SingletonServices>(
-  render: (services: SingletonServices, data: Data) => void | Promise<void>
-): PikkuCLIRender<Data, RequiredServices> => {
-  return render as any
-}
-
-/**
- * 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, 'cli' | 'rpc' | 'session'>, 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, 'cli' | 'rpc' | 'session'>,
-  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.json

@@ -1,147 +0,0 @@
-{
-  "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
-        },
-        "bootstrap": {
-          "pikkuFuncName": "bootstrap",
-          "positionals": [],
-          "options": {},
-          "description": "Generate only type files (setup phase only)"
-        },
-        "watch": {
-          "pikkuFuncName": "watch",
-          "positionals": [],
-          "options": {},
-          "description": "Watch for file changes and regenerate automatically"
-        },
-        "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"
-        },
-        "wireServicesFactoryType": {
-          "description": "Specify which wire services factory to use"
-        },
-        "stateOutput": {
-          "description": "Save inspector state to JSON file for reuse"
-        },
-        "stateInput": {
-          "description": "Load inspector state from JSON file (skips inspection)"
-        }
-      }
-    }
-  },
-  "renderers": {
-    "defaultCLIRenderer": {
-      "name": "defaultCLIRenderer",
-      "exportedName": "defaultCLIRenderer",
-      "services": {
-        "optimized": true,
-        "services": [
-          "logger",
-          "getInspectorState",
-          "schema",
-          "jwt",
-          "config",
-          "variables",
-          "secrets",
-          "workflowService",
-          "queueService",
-          "schedulerService"
-        ]
-      },
-      "filePath": "/home/runner/work/pikku/pikku/packages/cli/src/services.ts"
-    }
-  }
-}

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

@@ -1,7 +0,0 @@
-/**
- * This file was generated by @pikku/cli@0.11.3
- */
-import { pikkuState } from '@pikku/core'
-import { CLIMeta } from '@pikku/core/cli'
-import metaData from './pikku-cli-wirings-meta.gen.json' with { type: 'json' }
-pikkuState(null, 'cli', 'meta', metaData as CLIMeta)

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

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

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

@@ -1,41 +0,0 @@
-/**
- * This file was generated by @pikku/cli@0.11.3
- */
-
-import { executeCLI, CLIError } from '@pikku/core/cli'
-import { createConfig as createConfig } from '../../src/services.js'
-import { createSingletonServices as createSingletonServices } from '../../src/services.js'
-import { createWireServices as createWireServices } 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,
-      createWireServices,
-    })
-  } 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)
-  })
-}

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

@@ -1,83 +0,0 @@
-/**
- * This file was generated by @pikku/cli@0.11.3
- */
-/**
- * Forge-specific type definitions for typed wireForgeNode and wireForgeCredential
- */
-
-import { wireForgeNode as wireForgeNodeCore, wireForgeCredential as wireForgeCredentialCore } from '@pikku/core/forge-node'
-import type { CoreForgeNode, CoreForgeCredential } from '@pikku/core/forge-node'
-import type { FlattenedRPCMap } from '../rpc/pikku-rpc-wirings-map.internal.gen.js'
-
-/**
- * Valid category values for forge nodes.
- * No categories configured - wireForgeNode cannot be used until forge.node.categories is defined in pikku.config.json.
- */
-export type ForgeCategory = never
-
-/**
- * Valid RPC names that can be used with forge nodes.
- * These are derived from the FlattenedRPCMap which includes both local and external package RPCs.
- */
-export type ForgeRPCName = keyof FlattenedRPCMap
-
-/**
- * Typed forge node configuration.
- * Validates that category and rpc are valid values.
- */
-export type TypedForgeNode = Omit<CoreForgeNode, 'category' | 'rpc'> & {
-  /** Grouping category (validated against forge.node.categories in config) */
-  category: ForgeCategory
-  /** RPC name to call when node executes (must be a valid RPC name) */
-  rpc: ForgeRPCName
-}
-
-/**
- * Registers a Forge node with validated category and RPC.
- *
- * @param config - Forge node configuration with typed category and rpc
- *
- * @example
- * ```typescript
- * wireForgeNode({
- *   name: 'send-email',
- *   displayName: 'Send Email',
- *   category: 'Communication', // Must be in forge.node.categories
- *   type: 'action',
- *   rpc: 'sendEmail', // Must be a valid RPC name
- *   description: 'Sends an email to a recipient'
- * })
- * ```
- */
-export const wireForgeNode = (config: TypedForgeNode): void => {
-  wireForgeNodeCore(config as CoreForgeNode)
-}
-
-/**
- * Registers a Forge credential definition.
- * Credentials define secrets/API keys required by the package.
- *
- * @template T - Zod schema type for the credential structure
- * @param config - Forge credential configuration
- *
- * @example
- * ```typescript
- * import { z } from 'zod'
- *
- * const apiCredentials = z.object({
- *   apiKey: z.string().describe('API key for authentication'),
- *   apiSecret: z.string().describe('API secret')
- * })
- *
- * wireForgeCredential({
- *   name: 'example-api',
- *   displayName: 'Example API Credentials',
- *   description: 'Credentials for the example external API',
- *   secretId: 'EXAMPLE_API_CREDENTIALS',
- *   schema: apiCredentials
- * })
- * ```
- */
-export const wireForgeCredential = <T>(config: CoreForgeCredential<T>): void => {
-  wireForgeCredentialCore(config)
-}