@pikku/core 0.9.0 → 0.9.2

package/src/middleware-runner.ts

@@ -1,9 +1,8 @@
 import { UserSessionService } from './services/user-session-service.js'
 import {
   CoreSingletonServices,
-  PikkuFunctionMiddleware,
   PikkuInteraction,
-  PikkuMiddleware,
+  CorePikkuMiddleware,
 } from './types/core.types.js'
 
 /**
@@ -23,11 +22,7 @@ import {
  *   async () => { return await runMain(); }
  * );
  */
-export const runMiddleware = async <
-  Middleware extends
-    | PikkuMiddleware
-    | PikkuFunctionMiddleware = PikkuMiddleware,
->(
+export const runMiddleware = async <Middleware extends CorePikkuMiddleware>(
   services: CoreSingletonServices & {
     userSession?: UserSessionService<any>
   },

package/src/pikku-state.ts

@@ -4,7 +4,7 @@ import {
   HTTPMethod,
   HTTPWiringsMeta,
 } from './wirings/http/http.types.js'
-import { FunctionsMeta, PikkuMiddleware } from './types/core.types.js'
+import { FunctionsMeta, CorePikkuMiddleware } from './types/core.types.js'
 import {
   CoreScheduledTask,
   ScheduledTasksMeta,
@@ -41,7 +41,7 @@ interface PikkuState {
     >
   }
   http: {
-    middleware: Array<{ route: string; middleware: PikkuMiddleware[] }>
+    middleware: Array<{ route: string; middleware: CorePikkuMiddleware[] }>
     routes: Map<HTTPMethod, Map<string, CoreHTTPFunctionWiring<any, any, any>>>
     meta: HTTPWiringsMeta
   }

package/src/types/core.types.ts

@@ -30,6 +30,9 @@ export type FunctionsMeta = Record<
     schemaName: string | null
     inputs: string[] | null
     outputs: string[] | null
+    expose?: boolean
+    tags?: string[]
+    docs?: PikkuDocs
   }
 >
 
@@ -110,21 +113,7 @@ export interface PikkuInteraction {
 /**
  * A function that can wrap an interaction and be called before or after
  */
-export type PikkuFunctionMiddleware<
-  SingletonServices extends CoreSingletonServices = CoreSingletonServices,
-  UserSession extends CoreUserSession = CoreUserSession,
-> = (
-  services: SingletonServices & {
-    userSession?: UserSessionService<UserSession>
-  },
-  interactions: PikkuInteraction,
-  next: () => Promise<void>
-) => Promise<void>
-
-/**
- * A function that can wrap an interaction and be called before or after
- */
-export type PikkuMiddleware<
+export type CorePikkuMiddleware<
   SingletonServices extends CoreSingletonServices = CoreSingletonServices,
   UserSession extends CoreUserSession = CoreUserSession,
 > = (
@@ -190,7 +179,7 @@ export type CreateConfig<Config extends CoreConfig> = (
 /**
  * Represents the documentation for a route, including summary, description, tags, and errors.
  */
-export type APIDocs = {
+export type PikkuDocs = {
   summary?: string
   description?: string
   tags?: string[]

package/src/wirings/channel/channel.types.ts

@@ -5,10 +5,10 @@ import {
   PikkuHTTPResponse,
 } from '../http/http.types.js'
 import {
-  APIDocs,
+  PikkuDocs,
   CoreSingletonServices,
   CreateSessionServices,
-  PikkuMiddleware,
+  CorePikkuMiddleware,
 } from '../../types/core.types.js'
 import {
   CorePikkuFunction,
@@ -34,7 +34,7 @@ export type RunChannelParams<ChannelData> = {
 
 export interface ChannelMessageMeta {
   pikkuFuncName: string
-  docs?: APIDocs
+  docs?: PikkuDocs
 }
 
 export interface ChannelMeta {
@@ -48,7 +48,7 @@ export interface ChannelMeta {
   disconnect: ChannelMessageMeta | null
   message: ChannelMessageMeta | null
   messageWirings: Record<string, Record<string, ChannelMessageMeta>>
-  docs?: APIDocs
+  docs?: PikkuDocs
   tags?: string[]
 }
 
@@ -91,7 +91,7 @@ export type CoreChannel<
         }
     >
   >
-  middleware?: PikkuMiddleware[]
+  middleware?: CorePikkuMiddleware[]
   permissions?: Record<string, PikkuPermission[] | PikkuPermission>
   auth?: boolean
   docs?: Partial<{

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

@@ -1,7 +1,7 @@
 import { test, describe, beforeEach, afterEach } from 'node:test'
 import * as assert from 'assert'
 import { NotFoundError } from '../../errors/errors.js'
-import { JSONValue, PikkuMiddleware } from '../../types/core.types.js'
+import { JSONValue, CorePikkuMiddleware } from '../../types/core.types.js'
 import { fetch, wireHTTP } from './http-runner.js'
 import { pikkuState, resetPikkuState } from '../../pikku-state.js'
 import {
@@ -10,7 +10,7 @@ import {
 } from '../channel/local/local-channel-runner.test.js'
 import { addFunction } from '../../function/function-runner.js'
 
-const sessionMiddleware: PikkuMiddleware = async (services, _, next) => {
+const sessionMiddleware: CorePikkuMiddleware = async (services, _, next) => {
   services.userSession.set({ userId: 'test' } as any)
   await next()
 }

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

@@ -10,7 +10,7 @@ import {
 } from './http.types.js'
 import {
   CoreUserSession,
-  PikkuMiddleware,
+  CorePikkuMiddleware,
   SessionServices,
 } from '../../types/core.types.js'
 import { match } from 'path-to-regexp'
@@ -40,13 +40,13 @@ import { rpcService } from '../rpc/rpc-runner.js'
  * is applied only to that route. Otherwise, if an array is provided, it is treated
  * as global middleware (applied to all routes).
  *
- * @template APIMiddleware The middleware type.
- * @param {APIMiddleware[] | string} routeOrMiddleware - Either a global middleware array or a route pattern string.
- * @param {APIMiddleware[]} [middleware] - The middleware array to apply when a route pattern is specified.
+ * @template PikkuMiddleware The middleware type.
+ * @param {PikkuMiddleware[] | string} routeOrMiddleware - Either a global middleware array or a route pattern string.
+ * @param {PikkuMiddleware[]} [middleware] - The middleware array to apply when a route pattern is specified.
  */
-export const addMiddleware = <APIMiddleware extends PikkuMiddleware>(
-  routeOrMiddleware: APIMiddleware[] | string,
-  middleware?: APIMiddleware[]
+export const addHTTPMiddleware = <PikkuMiddleware extends CorePikkuMiddleware>(
+  routeOrMiddleware: PikkuMiddleware[] | string,
+  middleware?: PikkuMiddleware[]
 ) => {
   const middlewareStore = pikkuState('http', 'middleware')
 
@@ -90,8 +90,8 @@ export const addMiddleware = <APIMiddleware extends PikkuMiddleware>(
  * @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 {CoreHTTPFunctionWiring<In, Out, Route, PikkuFunction, PikkuFunctionSessionless, PikkuPermission, APIMiddleware>} httpWiring - The HTTP wiring configuration object.
+ * @template PikkuMiddleware Middleware type to be used with the route.
+ * @param {CoreHTTPFunctionWiring<In, Out, Route, PikkuFunction, PikkuFunctionSessionless, PikkuPermission, PikkuMiddleware>} httpWiring - The HTTP wiring configuration object.
  */
 export const wireHTTP = <
   In,
@@ -100,7 +100,7 @@ export const wireHTTP = <
   PikkuFunction,
   PikkuFunctionSessionless,
   PikkuPermissionGroup,
-  APIMiddleware,
+  PikkuMiddleware,
 >(
   httpWiring: CoreHTTPFunctionWiring<
     In,
@@ -109,7 +109,7 @@ export const wireHTTP = <
     PikkuFunction,
     PikkuFunctionSessionless,
     PikkuPermissionGroup,
-    APIMiddleware
+    PikkuMiddleware
   >
 ) => {
   const httpMeta = pikkuState('http', 'meta')

package/src/wirings/http/http.types.ts

@@ -1,12 +1,12 @@
 import type { SerializeOptions } from 'cookie'
 import type { PikkuError } from '../../errors/error-handler.js'
 import type {
-  APIDocs,
+  PikkuDocs,
   CoreServices,
   CoreSingletonServices,
   CoreUserSession,
   CreateSessionServices,
-  PikkuMiddleware,
+  CorePikkuMiddleware,
 } from '../../types/core.types.js'
 import type {
   CorePikkuFunction,
@@ -119,7 +119,7 @@ export type CoreHTTPFunctionWiring<
   PikkuFunction = CorePikkuFunction<In, Out>,
   PikkuFunctionSessionless = CorePikkuFunctionSessionless<In, Out>,
   PikkuPermission = CorePikkuPermission<In>,
-  APIMiddleware = PikkuMiddleware,
+  PikkuMiddleware = CorePikkuMiddleware,
 > =
   | (CoreHTTPFunction & {
       route: R
@@ -128,7 +128,7 @@ export type CoreHTTPFunctionWiring<
       permissions?: CorePermissionGroup<PikkuPermission>
       auth?: true
       tags?: string[]
-      middleware?: APIMiddleware[]
+      middleware?: PikkuMiddleware[]
       sse?: undefined
     })
   | (CoreHTTPFunction & {
@@ -138,7 +138,7 @@ export type CoreHTTPFunctionWiring<
       permissions?: undefined
       auth?: false
       tags?: string[]
-      middleware?: APIMiddleware[]
+      middleware?: PikkuMiddleware[]
       sse?: undefined
     })
   | (CoreHTTPFunction & {
@@ -149,7 +149,7 @@ export type CoreHTTPFunctionWiring<
       auth?: true
       sse?: boolean
       tags?: string[]
-      middleware?: APIMiddleware[]
+      middleware?: PikkuMiddleware[]
     })
   | (CoreHTTPFunction & {
       route: R
@@ -159,7 +159,7 @@ export type CoreHTTPFunctionWiring<
       auth?: false
       sse?: boolean
       tags?: string[]
-      middleware?: APIMiddleware[]
+      middleware?: PikkuMiddleware[]
     })
   | (CoreHTTPFunction & {
       route: R
@@ -169,7 +169,7 @@ export type CoreHTTPFunctionWiring<
       auth?: true
       query?: Array<keyof In>
       tags?: string[]
-      middleware?: APIMiddleware[]
+      middleware?: PikkuMiddleware[]
       sse?: undefined
     })
   | (CoreHTTPFunction & {
@@ -180,7 +180,7 @@ export type CoreHTTPFunctionWiring<
       auth?: false
       query?: Array<keyof In>
       tags?: string[]
-      middleware?: APIMiddleware[]
+      middleware?: PikkuMiddleware[]
       sse?: undefined
     })
 
@@ -203,7 +203,7 @@ export type HTTPWiringMeta = {
   params?: string[]
   query?: string[]
   inputTypes?: HTTPFunctionMetaInputTypes
-  docs?: APIDocs
+  docs?: PikkuDocs
   tags?: string[]
   sse?: true
 }
@@ -217,7 +217,7 @@ export type HTTPFunctionsMeta = Array<{
 
 export type HTTPWiringMiddleware = {
   route: string
-  middleware: PikkuMiddleware[]
+  middleware: CorePikkuMiddleware[]
 }
 
 export interface PikkuHTTPRequest<In = unknown> {

package/src/wirings/queue/queue.types.ts

@@ -1,4 +1,4 @@
-import { APIDocs } from '../../types/core.types.js'
+import { PikkuDocs } from '../../types/core.types.js'
 import { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 import { QueueConfigMapping } from './validate-worker-config.js'
 
@@ -155,7 +155,7 @@ export type queueWorkersMeta = Record<
     schemaName?: string
     queueName: string
     session?: undefined
-    docs?: APIDocs
+    docs?: PikkuDocs
     tags?: string[]
     config?: PikkuWorkerConfig
   }
@@ -170,7 +170,7 @@ export type CoreQueueWorker<
   queueName: string
   func: PikkuFunction
   config?: PikkuWorkerConfig
-  docs?: APIDocs
+  docs?: PikkuDocs
   session?: undefined
   tags?: string[]
 }

package/src/wirings/scheduler/scheduler.types.ts

@@ -1,4 +1,4 @@
-import { APIDocs, CoreUserSession } from '../../types/core.types.js'
+import { PikkuDocs, CoreUserSession } from '../../types/core.types.js'
 import { CorePikkuFunctionSessionless } from '../../function/functions.types.js'
 
 /**
@@ -12,7 +12,7 @@ export type ScheduledTasksMeta<UserSession extends CoreUserSession = any> =
       name: string
       schedule: string
       session?: UserSession
-      docs?: APIDocs
+      docs?: PikkuDocs
       tags?: string[]
     }
   >
@@ -26,6 +26,6 @@ export type CoreScheduledTask<
   name: string
   schedule: string
   func: PikkuFunction
-  docs?: APIDocs
+  docs?: PikkuDocs
   tags?: string[]
 }