@pikku/core 0.8.1 → 0.9.0

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

@@ -1,11 +1,11 @@
 import {
-  CoreHTTPFunctionRoute,
-  RunRouteOptions,
-  RunRouteParams,
+  CoreHTTPFunctionWiring,
+  RunHTTPWiringOptions,
+  RunHTTPWiringParams,
   PikkuHTTP,
   PikkuHTTPRequest,
   PikkuHTTPResponse,
-  HTTPRouteMeta,
+  HTTPWiringMeta,
   HTTPMethod,
 } from './http.types.js'
 import {
@@ -87,48 +87,49 @@ export const addMiddleware = <APIMiddleware extends PikkuMiddleware>(
  * @template In Expected input type.
  * @template Out Expected output type.
  * @template Route Route pattern as a string.
- * @template APIFunction Type for the route handler function.
- * @template APIFunctionSessionless Type for a sessionless handler.
- * @template APIPermissionGroup Type representing required permissions.
+ * @template PikkuFunction Type for the route handler function.
+ * @template PikkuFunctionSessionless Type for a sessionless handler.
+ * @template PikkuPermissionGroup Type representing required permissions.
  * @template APIMiddleware Middleware type to be used with the route.
- * @param {CoreHTTPFunctionRoute<In, Out, Route, APIFunction, APIFunctionSessionless, APIPermission, APIMiddleware>} route - The route configuration object.
+ * @param {CoreHTTPFunctionWiring<In, Out, Route, PikkuFunction, PikkuFunctionSessionless, PikkuPermission, APIMiddleware>} httpWiring - The HTTP wiring configuration object.
  */
-export const addHTTPRoute = <
+export const wireHTTP = <
   In,
   Out,
   Route extends string,
-  APIFunction,
-  APIFunctionSessionless,
-  APIPermissionGroup,
+  PikkuFunction,
+  PikkuFunctionSessionless,
+  PikkuPermissionGroup,
   APIMiddleware,
 >(
-  httpRoute: CoreHTTPFunctionRoute<
+  httpWiring: CoreHTTPFunctionWiring<
     In,
     Out,
     Route,
-    APIFunction,
-    APIFunctionSessionless,
-    APIPermissionGroup,
+    PikkuFunction,
+    PikkuFunctionSessionless,
+    PikkuPermissionGroup,
     APIMiddleware
   >
 ) => {
   const httpMeta = pikkuState('http', 'meta')
   const routeMeta = httpMeta.find(
-    (meta) => meta.route === httpRoute.route && meta.method === httpRoute.method
+    (meta) =>
+      meta.route === httpWiring.route && meta.method === httpWiring.method
   )
   if (!routeMeta) {
     throw new Error('Route metadata not found')
   }
   addFunction(routeMeta.pikkuFuncName, {
-    func: httpRoute.func,
+    func: httpWiring.func,
   })
   const routes = pikkuState('http', 'routes')
-  if (!routes.has(httpRoute.method)) {
-    routes.set(httpRoute.method, new Map())
+  if (!routes.has(httpWiring.method)) {
+    routes.set(httpWiring.method, new Map())
   }
   pikkuState('http', 'routes')
-    .get(httpRoute.method)
-    ?.set(httpRoute.route, httpRoute as any)
+    .get(httpWiring.method)
+    ?.set(httpWiring.route, httpWiring as any)
 }
 
 /**
@@ -242,9 +243,9 @@ const executeRouteWithMiddleware = async (
   matchedRoute: {
     matchedPath: any
     params: any
-    route: CoreHTTPFunctionRoute<any, any, any>
+    route: CoreHTTPFunctionWiring<any, any, any>
     middleware: any[]
-    meta: HTTPRouteMeta
+    meta: HTTPWiringMeta
   },
   http: PikkuHTTP,
   options: {
@@ -290,7 +291,7 @@ const executeRouteWithMiddleware = async (
       throw new MissingSessionError()
     }
 
-    const data = http.request!.data()
+    const data = await http.request!.data()
 
     const getAllServices = async () => {
       let channel: PikkuChannel<unknown, unknown> | undefined
@@ -382,12 +383,12 @@ const executeRouteWithMiddleware = async (
  * @template In Expected input data type.
  * @template Out Expected output data type.
  * @param {Request} request - The native Fetch API Request object.
- * @param {RunRouteOptions & RunRouteParams} params - Additional options including services and session management.
+ * @param {RunHTTPWiringOptions & RunHTTPWiringParams} params - Additional options including services and session management.
  * @returns {Promise<Response>} A promise that resolves to a Fetch API Response object.
  */
 export const fetch = async <In, Out>(
   request: Request,
-  params: RunRouteOptions & RunRouteParams
+  params: RunHTTPWiringOptions & RunHTTPWiringParams
 ): Promise<Response> => {
   const pikkuResponse = new PikkuFetchHTTPResponse()
   await fetchData<In, Out>(request, pikkuResponse, params)
@@ -403,12 +404,12 @@ export const fetch = async <In, Out>(
  * @template In Expected input data type.
  * @template Out Expected output data type.
  * @param {Request | PikkuHTTPRequest} request - The request object.
- * @param {RunRouteOptions & RunRouteParams} params - Execution options including services and session configuration.
+ * @param {RunHTTPWiringOptions & RunHTTPWiringParams} params - Execution options including services and session configuration.
  * @returns {Promise<PikkuFetchHTTPResponse>} A promise that resolves to a PikkuFetchHTTPResponse object.
  */
 export const pikkuFetch = async <In, Out>(
   request: Request | PikkuHTTPRequest,
-  params: RunRouteOptions & RunRouteParams
+  params: RunHTTPWiringOptions & RunHTTPWiringParams
 ): Promise<PikkuFetchHTTPResponse> => {
   const pikkuResponse = new PikkuFetchHTTPResponse()
   await fetchData<In, Out>(request, pikkuResponse, params)
@@ -430,7 +431,7 @@ export const pikkuFetch = async <In, Out>(
  * @template Out Expected output data type.
  * @param {Request | PikkuHTTPRequest} request - The incoming HTTP request.
  * @param {PikkuHTTPResponse} response - The response object to be populated.
- * @param {RunRouteOptions & RunRouteParams} options - Options such as singleton services, session handling, and error configuration.
+ * @param {RunHTTPWiringOptions & RunHTTPWiringParams} options - Options such as singleton services, session handling, and error configuration.
  * @returns {Promise<Out | void>} The output from the route handler or void if an error occurred.
  */
 export const fetchData = async <In, Out>(
@@ -446,7 +447,7 @@ export const fetchData = async <In, Out>(
     bubbleErrors = false,
     generateRequestId,
     ignoreMiddleware = false,
-  }: RunRouteOptions & RunRouteParams
+  }: RunHTTPWiringOptions & RunHTTPWiringParams
 ): Promise<Out | void> => {
   const requestId =
     (request as any).getHeader?.('x-request-id') ||

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'