@pikku/core 0.8.2 → 0.9.1

package/src/{events → wirings}/http/http.types.ts

@@ -9,25 +9,30 @@ import type {
   PikkuMiddleware,
 } from '../../types/core.types.js'
 import type {
-  CoreAPIFunction,
-  CoreAPIFunctionSessionless,
-  CoreAPIPermission,
+  CorePikkuFunction,
+  CorePikkuFunctionSessionless,
+  CorePikkuPermission,
   CorePermissionGroup,
 } from '../../function/functions.types.js'
 
-type ExtractRouteParams<S extends string> =
+type ExtractHTTPWiringParams<S extends string> =
   S extends `${string}:${infer Param}/${infer Rest}`
-    ? Param | ExtractRouteParams<`/${Rest}`>
+    ? Param | ExtractHTTPWiringParams<`/${Rest}`>
     : S extends `${string}:${infer Param}`
       ? Param
       : never
 
-export type AssertRouteParams<In, Route extends string> =
-  ExtractRouteParams<Route> extends keyof In
+export type AssertHTTPWiringParams<In, HTTPWiring extends string> =
+  ExtractHTTPWiringParams<HTTPWiring> extends keyof In
     ? unknown
-    : ['Error: Route parameters', ExtractRouteParams<Route>, 'not in', keyof In]
+    : [
+        'Error: HTTPWiring parameters',
+        ExtractHTTPWiringParams<HTTPWiring>,
+        'not in',
+        keyof In,
+      ]
 
-export type RunRouteOptions = Partial<{
+export type RunHTTPWiringOptions = Partial<{
   skipUserSession: boolean
   respondWith404: boolean
   logWarningsForStatusCodes: number[]
@@ -37,7 +42,7 @@ export type RunRouteOptions = Partial<{
   ignoreMiddleware: boolean
 }>
 
-export type RunRouteParams = {
+export type RunHTTPWiringParams = {
   singletonServices: CoreSingletonServices
   createSessionServices: CreateSessionServices<
     CoreSingletonServices,
@@ -47,8 +52,8 @@ export type RunRouteParams = {
 }
 
 /**
- * Represents the HTTP methods supported for API routes.
- */
+ * Represents the HTTP methods supported for API HTTP wirings.
+t */
 export type HTTPMethod =
   | 'post'
   | 'get'
@@ -59,7 +64,7 @@ export type HTTPMethod =
   | 'options'
 
 /**
- * Represents an API route without a function, including metadata such as content type, route, and timeout settings.
+ * Represents an API HTTP wiring without a function, including metadata such as content type, route, and timeout settings.
  */
 export type CoreHTTPFunction = {
   contentType?: 'xml' | 'json'
@@ -98,29 +103,29 @@ export type PikkuQuery<T = Record<string, string | undefined>> = Record<
 >
 
 /**
- * Represents a core API route, which can have different configurations depending on whether it requires authentication and permissions.
+ * Represents a core API HTTP wiring, which can have different configurations depending on whether it requires authentication and permissions.
  *
  * @template In - The input type.
  * @template Out - The output type.
  * @template R - The route string type.
- * @template APIFunction - The API function type, defaults to `CoreAPIFunction`.
- * @template APIFunctionSessionless - The sessionless API function type, defaults to `CoreAPIFunctionSessionless`.
- * @template APIPermission - The permission function type, defaults to `CoreAPIPermission`.
+ * @template PikkuFunction - The API function type, defaults to `CorePikkuFunction`.
+ * @template PikkuFunctionSessionless - The sessionless API function type, defaults to `CorePikkuFunctionSessionless`.
+ * @template PikkuPermission - The permission function type, defaults to `CorePikkuPermission`.
  */
-export type CoreHTTPFunctionRoute<
+export type CoreHTTPFunctionWiring<
   In,
   Out,
   R extends string,
-  APIFunction = CoreAPIFunction<In, Out>,
-  APIFunctionSessionless = CoreAPIFunctionSessionless<In, Out>,
-  APIPermission = CoreAPIPermission<In>,
+  PikkuFunction = CorePikkuFunction<In, Out>,
+  PikkuFunctionSessionless = CorePikkuFunctionSessionless<In, Out>,
+  PikkuPermission = CorePikkuPermission<In>,
   APIMiddleware = PikkuMiddleware,
 > =
   | (CoreHTTPFunction & {
       route: R
       method: HTTPMethod
-      func: APIFunction
-      permissions?: CorePermissionGroup<APIPermission>
+      func: PikkuFunction
+      permissions?: CorePermissionGroup<PikkuPermission>
       auth?: true
       tags?: string[]
       middleware?: APIMiddleware[]
@@ -129,7 +134,7 @@ export type CoreHTTPFunctionRoute<
   | (CoreHTTPFunction & {
       route: R
       method: HTTPMethod
-      func: APIFunctionSessionless
+      func: PikkuFunctionSessionless
       permissions?: undefined
       auth?: false
       tags?: string[]
@@ -139,8 +144,8 @@ export type CoreHTTPFunctionRoute<
   | (CoreHTTPFunction & {
       route: R
       method: 'get'
-      func: APIFunction
-      permissions?: CorePermissionGroup<APIPermission>
+      func: PikkuFunction
+      permissions?: CorePermissionGroup<PikkuPermission>
       auth?: true
       sse?: boolean
       tags?: string[]
@@ -149,7 +154,7 @@ export type CoreHTTPFunctionRoute<
   | (CoreHTTPFunction & {
       route: R
       method: 'get'
-      func: APIFunctionSessionless
+      func: PikkuFunctionSessionless
       permissions?: undefined
       auth?: false
       sse?: boolean
@@ -159,8 +164,8 @@ export type CoreHTTPFunctionRoute<
   | (CoreHTTPFunction & {
       route: R
       method: 'post'
-      func: APIFunction
-      permissions?: CorePermissionGroup<APIPermission>
+      func: PikkuFunction
+      permissions?: CorePermissionGroup<PikkuPermission>
       auth?: true
       query?: Array<keyof In>
       tags?: string[]
@@ -170,7 +175,7 @@ export type CoreHTTPFunctionRoute<
   | (CoreHTTPFunction & {
       route: R
       method: 'post'
-      func: APIFunctionSessionless
+      func: PikkuFunctionSessionless
       permissions?: undefined
       auth?: false
       query?: Array<keyof In>
@@ -180,7 +185,7 @@ export type CoreHTTPFunctionRoute<
     })
 
 /**
- * Represents the input types for route metadata, including parameters, query, and body types.
+ * Represents the input types for HTTP wiring metadata, including parameters, query, and body types.
  */
 export type HTTPFunctionMetaInputTypes = {
   params?: string
@@ -189,9 +194,9 @@ export type HTTPFunctionMetaInputTypes = {
 }
 
 /**
- * Represents metadata for a set of routes, including route details, methods, input/output types, and documentation.
+ * Represents metadata for a set of HTTP wirings, including HTTP wiring details, methods, input/output types, and documentation.
  */
-export type HTTPRouteMeta = {
+export type HTTPWiringMeta = {
   pikkuFuncName: string
   route: string
   method: HTTPMethod
@@ -202,7 +207,7 @@ export type HTTPRouteMeta = {
   tags?: string[]
   sse?: true
 }
-export type HTTPRoutesMeta = Array<HTTPRouteMeta>
+export type HTTPWiringsMeta = Array<HTTPWiringMeta>
 
 export type HTTPFunctionsMeta = Array<{
   name: string
@@ -210,7 +215,7 @@ export type HTTPFunctionsMeta = Array<{
   outputs: string[] | null
 }>
 
-export type HTTPRouteMiddleware = {
+export type HTTPWiringMiddleware = {
   route: string
   middleware: PikkuMiddleware[]
 }

package/src/{events → wirings}/http/index.ts

@@ -2,6 +2,6 @@ export * from './pikku-fetch-http-request.js'
 export * from './pikku-fetch-http-response.js'
 export * from './log-http-routes.js'
 
-export { fetch, fetchData, addHTTPRoute } from './http-runner.js'
+export { fetch, fetchData, wireHTTP } from './http-runner.js'
 
 export type * from './http.types.js'

package/src/{events → wirings}/mcp/mcp-runner.ts

@@ -13,7 +13,7 @@ import type {
   JsonRpcErrorResponse,
   PikkuMCP,
 } from './mcp.types.js'
-import type { CoreAPIFunctionSessionless } from '../../function/functions.types.js'
+import type { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 import { getErrorResponse } from '../../errors/error-handler.js'
 import { closeSessionServices } from '../../utils.js'
 import { pikkuState } from '../../pikku-state.js'
@@ -46,10 +46,10 @@ export type JsonRpcError = {
   data?: any
 }
 
-export const addMCPResource = <
-  APIFunction extends CoreAPIFunctionSessionless<any, any>,
+export const wireMCPResource = <
+  PikkuFunction extends CorePikkuFunctionSessionless<any, any>,
 >(
-  mcpResource: CoreMCPResource<APIFunction>
+  mcpResource: CoreMCPResource<PikkuFunction>
 ) => {
   const resourcesMeta = pikkuState('mcp', 'resourcesMeta')
   const mcpResourceMeta = resourcesMeta[mcpResource.uri]
@@ -66,10 +66,10 @@ export const addMCPResource = <
   resources.set(mcpResource.uri, mcpResource)
 }
 
-export const addMCPTool = <
-  APIFunction extends CoreAPIFunctionSessionless<any, any>,
+export const wireMCPTool = <
+  PikkuFunction extends CorePikkuFunctionSessionless<any, any>,
 >(
-  mcpTool: CoreMCPTool<APIFunction>
+  mcpTool: CoreMCPTool<PikkuFunction>
 ) => {
   const toolsMeta = pikkuState('mcp', 'toolsMeta')
   const mcpToolMeta = toolsMeta[mcpTool.name]
@@ -86,10 +86,10 @@ export const addMCPTool = <
   tools.set(mcpTool.name, mcpTool)
 }
 
-export const addMCPPrompt = <
-  APIFunction extends CoreAPIFunctionSessionless<any, any>,
+export const wireMCPPrompt = <
+  PikkuFunction extends CorePikkuFunctionSessionless<any, any>,
 >(
-  mcpPrompt: CoreMCPPrompt<APIFunction>
+  mcpPrompt: CoreMCPPrompt<PikkuFunction>
 ) => {
   const promptsMeta = pikkuState('mcp', 'promptsMeta')
   const mcpPromptMeta = promptsMeta[mcpPrompt.name]

package/src/{events → wirings}/mcp/mcp.types.ts

@@ -1,4 +1,4 @@
-import { CoreAPIFunctionSessionless } from '../../function/functions.types.js'
+import { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 
 export type PikkuMCP<Tools extends string = any> = {
   // elicitInput: <Input>(message: string) => Promise<{ action: string, content: Input }>
@@ -54,7 +54,7 @@ export type MCPPromptMeta = Record<
  * Represents an MCP resource with specific properties.
  */
 export type CoreMCPResource<
-  APIFunction = CoreAPIFunctionSessionless<any, any>,
+  PikkuFunction = CorePikkuFunctionSessionless<any, any>,
 > = {
   uri: string
   title: string
@@ -62,19 +62,21 @@ export type CoreMCPResource<
   mimeType?: string
   size?: number
   streaming?: boolean
-  func: APIFunction
+  func: PikkuFunction
   tags?: string[]
 }
 
 /**
  * Represents an MCP tool with specific properties.
  */
-export type CoreMCPTool<APIFunction = CoreAPIFunctionSessionless<any, any>> = {
+export type CoreMCPTool<
+  PikkuFunction = CorePikkuFunctionSessionless<any, any>,
+> = {
   name: string
   title?: string
   description: string
   annotations?: Record<string, any>
-  func: APIFunction
+  func: PikkuFunction
   tags?: string[]
   streaming?: boolean
 }
@@ -83,11 +85,11 @@ export type CoreMCPTool<APIFunction = CoreAPIFunctionSessionless<any, any>> = {
  * Represents an MCP prompt with specific properties.
  */
 export type CoreMCPPrompt<
-  APIFunction = CoreAPIFunctionSessionless<any, MCPPromptResponse>,
+  PikkuFunction = CorePikkuFunctionSessionless<any, MCPPromptResponse>,
 > = {
   name: string
   description?: string
-  func: APIFunction
+  func: PikkuFunction
   tags?: string[]
 }
 

package/src/{events → wirings}/queue/index.ts

@@ -3,7 +3,7 @@ export type * from './queue.types.js'
 
 // Queue processor management
 export {
-  addQueueWorker,
+  wireQueueWorker,
   runQueueJob,
   getQueueWorkers,
   removeQueueWorker,

package/src/{events → wirings}/queue/queue-runner.ts

@@ -1,6 +1,6 @@
 import type { CoreServices } from '../../types/core.types.js'
 import type { CoreQueueWorker, QueueJob } from './queue.types.js'
-import type { CoreAPIFunctionSessionless } from '../../function/functions.types.js'
+import type { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 import { getErrorResponse } from '../../errors/error-handler.js'
 import { pikkuState } from '../../pikku-state.js'
 import { addFunction, runPikkuFunc } from '../../function/function-runner.js'
@@ -17,15 +17,15 @@ class QueueWorkerNotFoundError extends Error {
 /**
  * Add a queue processor to the system
  */
-export const addQueueWorker = <
+export const wireQueueWorker = <
   InputData = any,
   OutputData = any,
-  APIFunction extends CoreAPIFunctionSessionless<
+  PikkuFunction extends CorePikkuFunctionSessionless<
     InputData,
     OutputData
-  > = CoreAPIFunctionSessionless<InputData, OutputData>,
+  > = CorePikkuFunctionSessionless<InputData, OutputData>,
 >(
-  queueWorker: CoreQueueWorker<APIFunction>
+  queueWorker: CoreQueueWorker<PikkuFunction>
 ) => {
   // Get processor metadata
   const meta = pikkuState('queue', 'meta')

package/src/{events → wirings}/queue/queue.types.ts

@@ -1,5 +1,5 @@
 import { APIDocs } from '../../types/core.types.js'
-import { CoreAPIFunctionSessionless } from '../../function/functions.types.js'
+import { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 import { QueueConfigMapping } from './validate-worker-config.js'
 
 /**
@@ -165,10 +165,10 @@ export type queueWorkersMeta = Record<
  * Core queue processor definition
  */
 export type CoreQueueWorker<
-  APIFunction = CoreAPIFunctionSessionless<any, any>,
+  PikkuFunction = CorePikkuFunctionSessionless<any, any>,
 > = {
   queueName: string
-  func: APIFunction
+  func: PikkuFunction
   config?: PikkuWorkerConfig
   docs?: APIDocs
   session?: undefined

package/src/{events → wirings}/scheduler/index.ts

@@ -2,7 +2,7 @@ export * from './scheduler.types.js'
 
 export {
   runScheduledTask,
-  addScheduledTask,
+  wireScheduler,
   getScheduledTasks,
 } from './scheduler-runner.js'
 

package/src/{events → wirings}/scheduler/scheduler-runner.ts

@@ -5,7 +5,7 @@ import type {
   CreateSessionServices,
 } from '../../types/core.types.js'
 import type { CoreScheduledTask } from './scheduler.types.js'
-import type { CoreAPIFunctionSessionless } from '../../function/functions.types.js'
+import type { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 import { getErrorResponse } from '../../errors/error-handler.js'
 import { closeSessionServices } from '../../utils.js'
 import { pikkuState } from '../../pikku-state.js'
@@ -23,10 +23,10 @@ export type RunScheduledTasksParams = {
   >
 }
 
-export const addScheduledTask = <
-  APIFunction extends CoreAPIFunctionSessionless<void, void>,
+export const wireScheduler = <
+  PikkuFunction extends CorePikkuFunctionSessionless<void, void>,
 >(
-  scheduledTask: CoreScheduledTask<APIFunction>
+  scheduledTask: CoreScheduledTask<PikkuFunction>
 ) => {
   const meta = pikkuState('scheduler', 'meta')
   const taskMeta = meta[scheduledTask.name]

package/src/{events → wirings}/scheduler/scheduler.types.ts

@@ -1,5 +1,5 @@
 import { APIDocs, CoreUserSession } from '../../types/core.types.js'
-import { CoreAPIFunctionSessionless } from '../../function/functions.types.js'
+import { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 
 /**
  * Represents metadata for scheduled tasks, including title, schedule, and documentation.
@@ -21,11 +21,11 @@ export type ScheduledTasksMeta<UserSession extends CoreUserSession = any> =
  * Represents a core scheduled task.
  */
 export type CoreScheduledTask<
-  APIFunction = CoreAPIFunctionSessionless<void, void>,
+  PikkuFunction = CorePikkuFunctionSessionless<void, void>,
 > = {
   name: string
   schedule: string
-  func: APIFunction
+  func: PikkuFunction
   docs?: APIDocs
   tags?: string[]
 }