@pikku/core 0.6.16 → 0.6.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/core",
-  "version": "0.6.16",
+  "version": "0.6.18",
   "author": "yasser.fadl@gmail.com",
   "license": "MIT",
   "module": "dist/index.js",
@@ -18,6 +18,7 @@
   },
   "exports": {
     ".": "./dist/index.js",
+    "./middleware": "./dist/middleware/index.js",
     "./channel": "./dist/channel/index.js",
     "./channel/local": "./dist/channel/local/index.js",
     "./channel/serverless": "./dist/channel/serverless/index.js",

package/src/channel/channel-handler.ts

@@ -6,7 +6,7 @@ import {
 } from '../types/core.types.js'
 import { CoreAPIChannel, PikkuChannelHandler } from './channel.types.js'
 import { verifyPermissions } from '../permissions.js'
-import { getChannels } from './channel-runner.js'
+import { pikkuState } from '../pikku-state.js'
 
 const validateSchema = (
   logger: CoreSingletonServices['logger'],
@@ -15,7 +15,7 @@ const validateSchema = (
   routingProperty?: string,
   routerValue?: string
 ) => {
-  const { channelsMeta } = getChannels()
+  const channelsMeta = pikkuState('channel', 'meta')
   for (const channelMeta of channelsMeta) {
     if (routingProperty && routerValue) {
       const channelRoute =

package/src/channel/channel-runner.ts

@@ -1,46 +1,14 @@
 import { NotFoundError } from '../errors/errors.js'
+import { pikkuState } from '../pikku-state.js'
 import { coerceQueryStringToArray, validateSchema } from '../schema.js'
 import { UserSessionService } from '../services/user-session-service.js'
 import {
   CoreAPIChannel,
-  ChannelsMeta,
-  CoreAPIChannels,
   RunChannelOptions,
   RunChannelParams,
 } from './channel.types.js'
 import { match } from 'path-to-regexp'
 
-if (!globalThis.pikku?.channels) {
-  globalThis.pikku = globalThis.pikku || {}
-  globalThis.pikku.channels = []
-  globalThis.pikku.channelsMeta = []
-}
-
-const channels = (data?: any): CoreAPIChannels => {
-  if (data) {
-    globalThis.pikku.channels = data
-  }
-  return globalThis.pikku.channels
-}
-
-const channelsMeta = (data?: any): ChannelsMeta => {
-  if (data) {
-    globalThis.pikku.channelsMeta = data
-  }
-  return globalThis.pikku.channelsMeta
-}
-
-/**
- * Returns all the registered routes and associated metadata.
- * @internal
- */
-export const getChannels = () => {
-  return {
-    channels: channels(),
-    channelsMeta: channelsMeta(),
-  }
-}
-
 export const addChannel = <
   In,
   Channel extends string,
@@ -56,18 +24,12 @@ export const addChannel = <
     APIPermission
   >
 ) => {
-  channels().push(channel as any)
-}
-
-/**
- * @ignore
- */
-export const setChannelsMeta = (_channelsMeta: ChannelsMeta) => {
-  channelsMeta(_channelsMeta)
+  pikkuState('channel', 'channels').push(channel as any)
 }
 
 export const getMatchingChannelConfig = (request: string) => {
-  const { channels, channelsMeta } = getChannels()
+  const channels = pikkuState('channel', 'channels')
+  const channelsMeta = pikkuState('channel', 'meta')
   for (const channelConfig of channels) {
     const cleanedRoute = channelConfig.route.replace(/^\/\//, '/')
     const cleanedRequest = request.replace(/^\/\//, '/')
@@ -96,7 +58,6 @@ export const openChannel = async ({
   singletonServices,
   coerceToArray = false,
   http,
-  userSessionService,
 }: Pick<CoreAPIChannel<unknown, string>, 'route'> &
   Omit<RunChannelParams<unknown>, 'response' | 'request'> & {
     userSessionService?: UserSessionService<any>

package/src/channel/channel-store.ts

@@ -1,32 +1,29 @@
 import { CoreUserSession } from '../types/core.types.js'
 
-export type Channel<
-  ChannelType = unknown,
-  OpeningData = unknown,
-  UserSession extends CoreUserSession = CoreUserSession,
-> = {
+export type Channel<ChannelType = unknown, OpeningData = unknown> = {
   channelId: string
   channelName: string
   channelObject?: ChannelType
   openingData?: OpeningData
-  userSession?: UserSession
 }
 
 export abstract class ChannelStore<
   ChannelType = unknown,
   OpeningData = unknown,
   UserSession extends CoreUserSession = CoreUserSession,
-  TypedChannel = Channel<ChannelType, OpeningData, UserSession>,
+  TypedChannel = Channel<ChannelType, OpeningData>,
 > {
   public abstract addChannel(
-    channel: Channel<ChannelType, OpeningData, UserSession>
+    channel: Channel<ChannelType, OpeningData>
   ): Promise<void> | void
   public abstract removeChannels(channelId: string[]): Promise<void> | void
   public abstract setUserSession(
     channelId: string,
-    userSession: any
+    userSession: UserSession | null
   ): Promise<void> | void
-  public abstract getChannel(
+  public abstract getChannelAndSession(
     channelId: string
-  ): Promise<TypedChannel> | TypedChannel
+  ):
+    | Promise<TypedChannel & { session: UserSession }>
+    | (TypedChannel & { session: UserSession })
 }

package/src/channel/index.ts

@@ -3,7 +3,6 @@ export * from './channel.types.js'
 export * from './log-channels.js'
 export * from './pikku-abstract-channel-handler.js'
 export * from './eventhub-service.js'
-export * from './eventhub-forwarder.js'
 export * from './eventhub-service.js'
 export * from './channel-store.js'
 export * from './eventhub-store.js'

package/src/channel/local/local-channel-runner.test.ts

@@ -4,6 +4,8 @@ import { JSONValue } from '../../types/core.types.js'
 import { PikkuHTTPAbstractRequest } from '../../http/pikku-http-abstract-request.js'
 import { PikkuHTTPAbstractResponse } from '../../http/pikku-http-abstract-response.js'
 import { runLocalChannel } from './local-channel-runner.js'
+import { resetPikkuState } from '../../pikku-state.js'
+import { addChannel } from '../channel-runner.js'
 
 /**
  * Minimal stubs for dependencies that runChannel expects.
@@ -49,28 +51,16 @@ class MockResponse extends PikkuHTTPAbstractResponse {
 }
 
 const mockCreateSessionServices = async () => ({ sessionServiceMock: true })
-function resetGlobalChannels(channels: any[] = [], channelsMeta: any[] = []) {
-  // If necessary, reinitialize globalThis.pikku
-  if (!globalThis.pikku) {
-    globalThis.pikku = {}
-  }
-  globalThis.pikku.channels = channels
-  globalThis.pikku.channelsMeta = channelsMeta
-  globalThis.pikku.openChannels = new Map()
-}
 
 beforeEach(() => {
-  resetGlobalChannels()
+  resetPikkuState()
 })
 
 afterEach(() => {
-  resetGlobalChannels()
+  resetPikkuState()
 })
 
 test('runChannel should return undefined and 404 if no matching channel is found', async () => {
-  // No channels configured
-  resetGlobalChannels()
-
   const mockResponse = new MockResponse()
 
   const result = await runLocalChannel({
@@ -92,12 +82,12 @@ test('runChannel should return undefined and 404 if no matching channel is found
 })
 
 test('runChannel should return a channel handler if channel matches and no auth required', async () => {
-  resetGlobalChannels([
-    {
-      route: '/test-channel',
-      auth: false,
-    },
-  ])
+  resetPikkuState()
+  addChannel({
+    name: 'test',
+    route: '/test-channel',
+    auth: false,
+  })
 
   // Provide a fake channelPermissionService if needed
   const singletonServicesWithPerm = {

package/src/channel/local/local-channel-runner.ts

@@ -64,7 +64,7 @@ export const runLocalChannel = async ({
       const allServices = {
         ...singletonServices,
         ...sessionServices,
-        userSessionService,
+        userSession: userSessionService,
       }
 
       channelHandler.registerOnOpen(() => {
@@ -101,7 +101,7 @@ export const runLocalChannel = async ({
   await runMiddleware(
     {
       ...singletonServices,
-      userSessionService,
+      userSession: userSessionService,
     },
     { http },
     route.middleware || [],

package/src/channel/log-channels.ts

@@ -1,12 +1,12 @@
+import { pikkuState } from '../pikku-state.js'
 import { Logger } from '../services/index.js'
-import { getChannels } from './channel-runner.js'
 
 /**
  * Logs all the loaded channels.
  * @param logger - A logger for logging information.
  */
 export const logChannels = (logger: Logger) => {
-  const { channels } = getChannels()
+  const channels = pikkuState('channel', 'channels')
   if (channels.length === 0) {
     logger.info('No channels added')
     return

package/src/channel/serverless/serverless-channel-runner.ts

@@ -1,7 +1,7 @@
 import { SessionServices } from '../../types/core.types.js'
 import { closeSessionServices } from '../../utils.js'
 import { processMessageHandlers } from '../channel-handler.js'
-import { getChannels, openChannel } from '../channel-runner.js'
+import { openChannel } from '../channel-runner.js'
 import type {
   CoreAPIChannel,
   RunChannelOptions,
@@ -13,6 +13,7 @@ import { ChannelStore } from '../channel-store.js'
 import { handleError } from '../../handle-error.js'
 import { RemoteUserSessionService } from '../../services/user-session-service.js'
 import { runMiddleware } from '../../middleware-runner.js'
+import { pikkuState } from '../../pikku-state.js'
 
 export interface RunServerlessChannelParams<ChannelData>
   extends RunChannelParams<ChannelData> {
@@ -32,7 +33,7 @@ const getVariablesForChannel = ({
   channelHandlerFactory: PikkuChannelHandlerFactory
   openingData?: unknown
 }) => {
-  const { channels } = getChannels()
+  const channels = pikkuState('channel', 'channels')
   const channelConfig = channels.find(
     (channelConfig) => channelConfig.name === channelName
   )
@@ -129,7 +130,7 @@ export const runChannelConnect = async ({
   await runMiddleware(
     {
       ...singletonServices,
-      userSessionService,
+      userSession: userSessionService,
     },
     { http },
     channelConfig.middleware || [],
@@ -142,8 +143,8 @@ export const runChannelDisconnect = async ({
   ...params
 }: RunServerlessChannelParams<unknown>): Promise<void> => {
   let sessionServices: SessionServices | undefined
-  const { userSession, openingData, channelName } =
-    await params.channelStore.getChannel(params.channelId)
+  const { openingData, channelName, session } =
+    await params.channelStore.getChannelAndSession(params.channelId)
   const { channel, channelConfig } = getVariablesForChannel({
     ...params,
     openingData,
@@ -153,7 +154,7 @@ export const runChannelDisconnect = async ({
     sessionServices = await params.createSessionServices(
       singletonServices,
       {},
-      userSession
+      session
     )
   }
   await channelConfig.onDisconnect?.(
@@ -171,8 +172,8 @@ export const runChannelMessage = async (
   data: unknown
 ): Promise<unknown> => {
   let sessionServices: SessionServices | undefined
-  const { userSession, openingData, channelName } =
-    await params.channelStore.getChannel(params.channelId)
+  const { openingData, channelName, session } =
+    await params.channelStore.getChannelAndSession(params.channelId)
   const { channelHandler, channelConfig } = getVariablesForChannel({
     ...params,
     openingData,
@@ -182,7 +183,7 @@ export const runChannelMessage = async (
     sessionServices = await params.createSessionServices(
       singletonServices,
       {},
-      userSession
+      session
     )
   }
   let response: unknown

package/src/errors/error-handler.ts

@@ -1,3 +1,5 @@
+import { pikkuState } from '../pikku-state.js'
+
 /**
  * Base class for custom errors.
  * @extends {Error}
@@ -21,19 +23,7 @@ export interface ErrorDetails {
   message: string
 }
 
-/**
- * Map of API errors to their details.
- */
-if (!globalThis.pikku?.apiErrors) {
-  globalThis.pikku = globalThis.pikku || {}
-  globalThis.pikku.apiErrors = new Map<any, ErrorDetails>([])
-}
-
-const apiErrors = (): Map<any, ErrorDetails> => {
-  return globalThis.pikku.apiErrors
-}
-
-export const getErrors = () => apiErrors()
+export const getErrors = () => pikkuState('errors', 'errors')
 
 /**
  * Adds an error to the API errors map.
@@ -41,7 +31,7 @@ export const getErrors = () => apiErrors()
  * @param details - The details of the error.
  */
 export const addError = (error: any, { status, message }: ErrorDetails) => {
-  apiErrors().set(error, { status, message })
+  pikkuState('errors', 'errors').set(error, { status, message })
 }
 
 /**
@@ -64,11 +54,10 @@ export const addErrors = (
 export const getErrorResponse = (
   error: Error
 ): { status: number; message: string } | undefined => {
-  const foundError = Array.from(apiErrors().entries()).find(
-    ([e]) => e.name === error.constructor.name
-  )
+  const errors = Array.from(pikkuState('errors', 'errors').entries())
+  const foundError = errors.find(([e]) => e.name === error.constructor.name)
   if (foundError) {
     return foundError[1]
   }
-  return apiErrors().get(error)
+  return pikkuState('errors', 'errors').get(error)
 }

package/src/errors/errors.ts

@@ -121,14 +121,13 @@ addError(ProxyAuthenticationRequiredError, {
 })
 
 /**
- * The server did not receive a timely response from an upstream server.
+ * The server request expired
  * @group Error
  */
 export class RequestTimeoutError extends PikkuError {}
 addError(RequestTimeoutError, {
   status: 408,
-  message:
-    'The server did not receive a timely response from an upstream server.',
+  message: 'The request timeout has expired.',
 })
 
 /**

package/src/handle-error.ts

@@ -30,7 +30,6 @@ export const handleError = (
 
   // Get appropriate error response
   const errorResponse = getErrorResponse(e)
-
   if (errorResponse != null) {
     // Set status and response body
     http?.response?.setStatus(errorResponse.status)

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

@@ -4,7 +4,8 @@ import { NotFoundError } from '../errors/errors.js'
 import { PikkuHTTPAbstractRequest } from './pikku-http-abstract-request.js'
 import { PikkuHTTPAbstractResponse } from './pikku-http-abstract-response.js'
 import { JSONValue, PikkuMiddleware } from '../types/core.types.js'
-import { runHTTPRoute, clearRoutes, addRoute } from './http-route-runner.js'
+import { runHTTPRoute, addRoute } from './http-route-runner.js'
+import { resetPikkuState } from '../pikku-state.js'
 
 class PikkuTestRequest extends PikkuHTTPAbstractRequest {
   public getBody(): Promise<unknown> {
@@ -39,7 +40,7 @@ describe('runHTTPRoute', () => {
   let response: any
 
   beforeEach(() => {
-    clearRoutes()
+    resetPikkuState()
 
     singletonServices = {
       logger: {

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

@@ -1,13 +1,11 @@
 import { verifyPermissions } from '../permissions.js'
 import {
   CoreHTTPFunctionRoute,
-  HTTPRoutesMeta,
   RunRouteOptions,
   RunRouteParams,
   PikkuHTTP,
-  HTTPRouteMiddleware,
 } from './http-routes.types.js'
-import { SessionServices } from '../types/core.types.js'
+import { PikkuMiddleware, SessionServices } from '../types/core.types.js'
 import { match } from 'path-to-regexp'
 import { PikkuHTTPAbstractRequest } from './pikku-http-abstract-request.js'
 import { PikkuHTTPAbstractResponse } from './pikku-http-abstract-response.js'
@@ -24,59 +22,7 @@ import { coerceQueryStringToArray, validateSchema } from '../schema.js'
 import { LocalUserSessionService } from '../services/user-session-service.js'
 import { runMiddleware } from '../middleware-runner.js'
 import { handleError } from '../handle-error.js'
-
-/**
- * Initialize global state for HTTP routes and middleware if not already available
- */
-if (!globalThis.pikku?.httpRoutes) {
-  globalThis.pikku = globalThis.pikku || {}
-  globalThis.pikku.httpMiddleware = []
-  globalThis.pikku.httpRoutes = []
-  globalThis.pikku.httpRoutesMeta = []
-}
-
-/**
- * Get or set the global HTTP routes
- *
- * @param {CoreHTTPFunctionRoute<any, any, any>[]} [data] - Optional routes data to set
- * @returns {CoreHTTPFunctionRoute<any, any, any>[]} Current routes
- */
-const httpRoutes = (
-  data?: CoreHTTPFunctionRoute<any, any, any>[]
-): CoreHTTPFunctionRoute<any, any, any>[] => {
-  if (data) {
-    globalThis.pikku.httpRoutes = data
-  }
-  return globalThis.pikku.httpRoutes
-}
-
-/**
- * Get or set the global HTTP route metadata
- *
- * @param {HTTPRoutesMeta} [data] - Optional route metadata to set
- * @returns {HTTPRoutesMeta} Current route metadata
- */
-const httpRoutesMeta = (data?: HTTPRoutesMeta): HTTPRoutesMeta => {
-  if (data) {
-    globalThis.pikku.httpRoutesMeta = data
-  }
-  return globalThis.pikku.httpRoutesMeta
-}
-
-/**
- * Get or set the global HTTP middleware
- *
- * @param {HTTPRouteMiddleware[]} [data] - Optional middleware to set
- * @returns {HTTPRouteMiddleware[]} Current middleware
- */
-const httpMiddleware = (
-  data?: HTTPRouteMiddleware[]
-): HTTPRouteMiddleware[] => {
-  if (data) {
-    globalThis.pikku.httpMiddleware = data
-  }
-  return globalThis.pikku.httpMiddleware
-}
+import { pikkuState } from '../pikku-state.js'
 
 /**
  * Add middleware to a specific route or globally
@@ -84,19 +30,19 @@ const httpMiddleware = (
  * @param {APIMiddleware[] | string} routeOrMiddleware - Route pattern to match or middleware array
  * @param {APIMiddleware} [middleware] - Middleware to add (required if first param is a string)
  */
-export const addMiddleware = <APIMiddleware>(
+export const addMiddleware = <APIMiddleware extends PikkuMiddleware>(
   routeOrMiddleware: APIMiddleware[] | string,
-  middleware?: APIMiddleware
+  middleware?: APIMiddleware[]
 ) => {
-  if (typeof routeOrMiddleware === 'string') {
-    globalThis.pikku.httpMiddleware.push({
+  if (typeof routeOrMiddleware === 'string' && middleware) {
+    pikkuState('http', 'middleware').push({
       route: routeOrMiddleware,
-      middleware: middleware!,
+      middleware,
     })
   } else {
-    globalThis.pikku.httpMiddleware.push({
+    pikkuState('http', 'middleware').push({
       route: '*',
-      middleware: routeOrMiddleware,
+      middleware: routeOrMiddleware as any,
     })
   }
 }
@@ -125,37 +71,7 @@ export const addRoute = <
     APIMiddleware
   >
 ) => {
-  httpRoutes().push(route as any)
-}
-
-/**
- * Remove all routes from the global registry
- */
-export const clearRoutes = () => {
-  httpRoutes([])
-}
-
-/**
- * Set the HTTP routes metadata
- *
- * @param {HTTPRoutesMeta} routeMeta - Metadata for routes
- * @ignore
- */
-export const setHTTPRoutesMeta = (routeMeta: HTTPRoutesMeta) => {
-  httpRoutesMeta(routeMeta)
-}
-
-/**
- * Returns all the registered routes and associated metadata
- *
- * @returns {Object} Object containing routes and routesMeta
- * @internal
- */
-export const getRoutes = () => {
-  return {
-    routes: httpRoutes(),
-    routesMeta: httpRoutesMeta(),
-  }
+  pikkuState('http', 'routes').push(route as any)
 }
 
 /**
@@ -166,7 +82,11 @@ export const getRoutes = () => {
  * @returns {Object | undefined} Matching route information or undefined if no match
  */
 const getMatchingRoute = (requestType: string, requestPath: string) => {
-  for (const route of httpRoutes()) {
+  const routes = pikkuState('http', 'routes')
+  const middleware = pikkuState('http', 'middleware')
+  const routesMeta = pikkuState('http', 'meta')
+
+  for (const route of routes) {
     // Skip routes that don't match the request method
     if (route.method !== requestType.toLowerCase()) {
       continue
@@ -182,13 +102,13 @@ const getMatchingRoute = (requestType: string, requestPath: string) => {
 
     if (matchedPath) {
       // Get all middleware for this route
-      const globalMiddleware = httpMiddleware()
+      const globalMiddleware = middleware
         .filter((m) => m.route === '*' || new RegExp(m.route).test(route.route))
         .map((m) => m.middleware)
         .flat()
 
       // Find schema for this route
-      const schemaName = httpRoutesMeta().find(
+      const schemaName = routesMeta.find(
         (routeMeta) =>
           routeMeta.method === route.method && routeMeta.route === route.route
       )?.input
@@ -269,7 +189,6 @@ const executeRouteWithMiddleware = async (
     createSessionServices,
     skipUserSession,
   } = services
-  const { coerceToArray } = options
 
   const requiresSession = route.auth !== false
   let sessionServices: any
@@ -318,7 +237,7 @@ const executeRouteWithMiddleware = async (
       data
     )
 
-    if (coerceToArray && schemaName) {
+    if (options.coerceToArray && schemaName) {
       coerceQueryStringToArray(schemaName, data)
     }
 

package/src/http/index.ts

@@ -4,11 +4,6 @@ export * from './pikku-http-abstract-response.js'
 
 export * from './log-http-routes.js'
 
-export {
-  runHTTPRoute,
-  getRoutes,
-  setHTTPRoutesMeta,
-  addRoute,
-} from './http-route-runner.js'
+export { runHTTPRoute, addRoute } from './http-route-runner.js'
 
 export type * from './http-routes.types.js'

package/src/http/log-http-routes.ts

@@ -1,12 +1,12 @@
+import { pikkuState } from '../pikku-state.js'
 import { Logger } from '../services/index.js'
-import { getRoutes } from './http-route-runner.js'
 
 /**
  * Logs all the loaded routes.
  * @param logger - A logger for logging information.
  */
 export const logRoutes = (logger: Logger) => {
-  const { routes } = getRoutes()
+  const routes = pikkuState('http', 'routes')
   if (routes.length === 0) {
     logger.info('No routes added')
     return

package/src/index.ts

@@ -12,7 +12,8 @@ export * from './scheduler/index.js'
 export * from './errors/index.js'
 export * from './middleware/index.js'
 
+export { pikkuState } from './pikku-state.js'
 export { runMiddleware } from './middleware-runner.js'
-export { addRoute } from './http/http-route-runner.js'
+export { addRoute, addMiddleware } from './http/http-route-runner.js'
 export { addChannel } from './channel/channel-runner.js'
 export { addScheduledTask } from './scheduler/scheduler-runner.js'