@pikku/core 0.12.0 → 0.12.2

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

@@ -1,20 +1,19 @@
-import {
+import type {
   CoreHTTPFunctionWiring,
   RunHTTPWiringOptions,
-  RunHTTPWiringParams,
   PikkuHTTP,
   PikkuHTTPRequest,
   PikkuHTTPResponse,
   HTTPWiringMeta,
   HTTPMethod,
 } from './http.types.js'
-import {
+import type {
   CorePikkuFunction,
   CorePikkuFunctionSessionless,
   CorePikkuPermission,
   CorePermissionGroup,
 } from '../../function/functions.types.js'
-import {
+import type {
   CoreUserSession,
   CorePikkuMiddleware,
   CorePikkuMiddlewareGroup,
@@ -29,17 +28,19 @@ import {
   isSerializable,
 } from '../../utils.js'
 import {
-  PikkuSessionService,
-  createMiddlewareSessionWireProps,
-} from '../../services/user-session-service.js'
+  getSingletonServices,
+  getCreateWireServices,
+} from '../../pikku-state.js'
+import { PikkuSessionService } from '../../services/user-session-service.js'
 import { handleHTTPError } from '../../handle-error.js'
 import { pikkuState } from '../../pikku-state.js'
 import { PikkuFetchHTTPResponse } from './pikku-fetch-http-response.js'
 import { PikkuFetchHTTPRequest } from './pikku-fetch-http-request.js'
-import { PikkuChannel } from '../channel/channel.types.js'
+import type { PikkuChannel } from '../channel/channel.types.js'
 import { addFunction, runPikkuFunc } from '../../function/function-runner.js'
 import { httpRouter } from './routers/http-router.js'
 import { validateSchema } from '../../schema.js'
+import { runMiddleware } from '../../middleware-runner.js'
 
 /**
  * Extract headers from a PikkuHTTPRequest based on the schema keys
@@ -358,6 +359,9 @@ const executeRoute = async (
       send: (data: any) => {
         response.arrayBuffer(isSerializable(data) ? JSON.stringify(data) : data)
       },
+      sendBinary: (data) => {
+        response.arrayBuffer(data)
+      },
       close: () => {
         channel!.state = 'closed'
         response.close?.()
@@ -369,7 +373,10 @@ const executeRoute = async (
   const wire: PikkuWire = {
     http,
     channel,
-    ...createMiddlewareSessionWireProps(userSession),
+    session: userSession.get() as CoreUserSession | undefined,
+    setSession: (s: any) => userSession.setInitial(s),
+    getSession: () => userSession.get(),
+    hasSessionChanged: () => userSession.sessionChanged,
   }
 
   result = await runPikkuFunc(
@@ -417,12 +424,12 @@ const executeRoute = async (
  * @template In Expected input data type.
  * @template Out Expected output data type.
  * @param {Request} request - The native Fetch API Request object.
- * @param {RunHTTPWiringOptions & RunHTTPWiringParams} params - Additional options including services and session management.
+ * @param {RunHTTPWiringOptions} 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: RunHTTPWiringOptions & RunHTTPWiringParams
+  params: RunHTTPWiringOptions = {}
 ): Promise<Response> => {
   const pikkuResponse = new PikkuFetchHTTPResponse()
   await fetchData<In, Out>(request, pikkuResponse, params)
@@ -438,12 +445,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 {RunHTTPWiringOptions & RunHTTPWiringParams} params - Execution options including services and session configuration.
+ * @param {RunHTTPWiringOptions} 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: RunHTTPWiringOptions & RunHTTPWiringParams
+  params: RunHTTPWiringOptions = {}
 ): Promise<PikkuFetchHTTPResponse> => {
   const pikkuResponse = new PikkuFetchHTTPResponse()
   await fetchData<In, Out>(request, pikkuResponse, params)
@@ -465,43 +472,56 @@ 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 {RunHTTPWiringOptions & RunHTTPWiringParams} options - Options such as singleton services, session handling, and error configuration.
+ * @param {RunHTTPWiringOptions} 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>(
   request: Request | PikkuHTTPRequest,
   response: PikkuHTTPResponse,
   {
-    singletonServices,
-    createWireServices,
     skipUserSession = false,
     respondWith404 = true,
     logWarningsForStatusCodes = [],
     coerceDataFromSchema = true,
     bubbleErrors = false,
     generateRequestId,
-  }: RunHTTPWiringOptions & RunHTTPWiringParams
+  }: RunHTTPWiringOptions = {}
 ): Promise<Out | void> => {
-  const requestId =
-    (request as any).getHeader?.('x-request-id') ||
-    generateRequestId?.() ||
-    createWeakUID()
+  const singletonServices = getSingletonServices()
+  const createWireServices = getCreateWireServices()
   let wireServices: WireServices<typeof singletonServices> | undefined
   let result: Out
 
   // Combine the request and response into one wire object
-  const http = createHTTPWire(
-    request instanceof Request ? new PikkuFetchHTTPRequest(request) : request,
-    response
-  )
+  const pikkuRequest =
+    request instanceof Request ? new PikkuFetchHTTPRequest(request) : request
+  let requestId: string | null = null
+  try {
+    requestId = pikkuRequest.header('x-request-id')
+  } catch {}
+  requestId = requestId || generateRequestId?.() || createWeakUID()
+  const http = createHTTPWire(pikkuRequest, response)
   const apiType = http!.request!.method()
   const apiRoute = http!.request!.path()
 
   // Locate the matching route based on the HTTP method and path
   const matchedRoute = getMatchingRoute(apiType, apiRoute)
   try {
-    // If no route matches, log the occurrence and throw a NotFoundError
     if (!matchedRoute) {
+      if (apiType.toLowerCase() === 'options') {
+        const httpGroups = pikkuState(null, 'middleware', 'httpGroup')
+        const globalMiddleware = httpGroups['*']
+        const wire: PikkuWire = { http: http! }
+        if (globalMiddleware) {
+          await runMiddleware(
+            singletonServices,
+            wire,
+            globalMiddleware as CorePikkuMiddleware[]
+          )
+        }
+        response.status(204).json(undefined as any)
+        return
+      }
       singletonServices.logger.info({
         message: 'Route not found',
         apiRoute,
@@ -525,7 +545,6 @@ export const fetchData = async <In, Out>(
 
     return result
   } catch (e: any) {
-    // Handle errors and, depending on configuration, bubble them up or respond with an error
     handleHTTPError(
       e,
       http,

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

@@ -1,11 +1,7 @@
 import type { SerializeOptions } from 'cookie'
 import type { StandardSchemaV1 } from '@standard-schema/spec'
-import { PikkuError } from '../../errors/error-handler.js'
+import type { PikkuError } from '../../errors/error-handler.js'
 import type {
-  CoreServices,
-  CoreSingletonServices,
-  CoreUserSession,
-  CreateWireServices,
   CorePikkuMiddleware,
   CommonWireMeta,
 } from '../../types/core.types.js'
@@ -43,15 +39,6 @@ export type RunHTTPWiringOptions = Partial<{
   generateRequestId: () => string
 }>
 
-export type RunHTTPWiringParams = {
-  singletonServices: CoreSingletonServices
-  createWireServices?: CreateWireServices<
-    CoreSingletonServices,
-    CoreServices<CoreSingletonServices>,
-    CoreUserSession
-  >
-}
-
 /**
  * Represents the HTTP methods supported for API HTTP wirings.
  */

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

@@ -1,5 +1,5 @@
 import { pikkuState } from '../../pikku-state.js'
-import { Logger } from '../../services/index.js'
+import type { Logger } from '../../services/index.js'
 
 /**
  * Logs all the loaded routes.

package/src/wirings/http/pikku-fetch-http-request.ts

@@ -1,6 +1,6 @@
 import { parse as parseQuery } from 'picoquery'
 import { parse as parseCookie } from 'cookie'
-import { HTTPMethod, PikkuHTTPRequest, PikkuQuery } from './http.types.js'
+import type { HTTPMethod, PikkuHTTPRequest, PikkuQuery } from './http.types.js'
 import { UnprocessableContentError } from '../../errors/errors.js'
 
 /**

package/src/wirings/http/pikku-fetch-http-response.ts

@@ -1,8 +1,6 @@
-import { PikkuHTTPResponse } from './http.types.js'
-import {
-  SerializeOptions as CookieSerializeOptions,
-  serialize as serializeCookie,
-} from 'cookie'
+import type { PikkuHTTPResponse } from './http.types.js'
+import type { SerializeOptions as CookieSerializeOptions } from 'cookie'
+import { serialize as serializeCookie } from 'cookie'
 
 export class PikkuFetchHTTPResponse implements PikkuHTTPResponse {
   #statusCode: number = 200
@@ -91,6 +89,15 @@ export class PikkuFetchHTTPResponse implements PikkuHTTPResponse {
   // }
 
   public redirect(location: string, status: number = 302): this {
+    if (
+      !location.startsWith('/') &&
+      !location.startsWith('https://') &&
+      !location.startsWith('http://')
+    ) {
+      throw new Error(
+        'Invalid redirect location: must be a relative path or absolute URL'
+      )
+    }
     this.#statusCode = status
     this.header('Location', location)
     return this

package/src/wirings/http/routers/http-router.ts

@@ -1,4 +1,4 @@
-import { HTTPMethod } from '../http.types.js'
+import type { HTTPMethod } from '../http.types.js'
 import { PathToRegexRouter } from './path-to-regex.js'
 
 export type MatchResult = {

package/src/wirings/http/routers/path-to-regex.test.ts

@@ -2,7 +2,7 @@ import { test, describe, beforeEach } from 'node:test'
 import * as assert from 'node:assert/strict'
 import { PathToRegexRouter } from './path-to-regex.js'
 import { resetPikkuState, pikkuState } from '../../../pikku-state.js'
-import { HTTPMethod } from '../http.types.js'
+import type { HTTPMethod } from '../http.types.js'
 
 describe('PathToRegexRouter', () => {
   let router: PathToRegexRouter

package/src/wirings/http/routers/path-to-regex.ts

@@ -1,6 +1,7 @@
-import { match, MatchFunction } from 'path-to-regexp'
-import { MatchResult, Router } from './http-router.js'
-import { HTTPMethod } from '../http.types.js'
+import type { MatchFunction } from 'path-to-regexp'
+import { match } from 'path-to-regexp'
+import type { MatchResult, Router } from './http-router.js'
+import type { HTTPMethod } from '../http.types.js'
 import { pikkuState } from '../../../pikku-state.js'
 
 interface CompiledRoute {

package/src/wirings/mcp/mcp-endpoint-registry.ts

@@ -1,4 +1,8 @@
-import { MCPResourceMeta, MCPToolMeta, MCPPromptMeta } from '@pikku/core/mcp'
+import type {
+  MCPResourceMeta,
+  MCPToolMeta,
+  MCPPromptMeta,
+} from '@pikku/core/mcp'
 
 export interface MCPToolEndpoint {
   name: string

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

@@ -1,10 +1,4 @@
-import {
-  PikkuWire,
-  type CoreServices,
-  type CoreSingletonServices,
-  type CoreUserSession,
-  type CreateWireServices,
-} from '../../types/core.types.js'
+import type { PikkuWire } from '../../types/core.types.js'
 import type {
   CoreMCPResource,
   CoreMCPPrompt,
@@ -19,7 +13,11 @@ import type {
 } from '../../function/functions.types.js'
 import { getErrorResponse } from '../../errors/error-handler.js'
 import { closeWireServices } from '../../utils.js'
-import { pikkuState } from '../../pikku-state.js'
+import {
+  pikkuState,
+  getSingletonServices,
+  getCreateWireServices,
+} from '../../pikku-state.js'
 import { addFunction, runPikkuFunc } from '../../function/function-runner.js'
 import {
   BadRequestError,
@@ -40,13 +38,7 @@ export class MCPError extends Error {
 }
 
 export type RunMCPEndpointParams<Tools extends string = any> = {
-  singletonServices: CoreSingletonServices
   mcp?: PikkuMCP<Tools>
-  createWireServices?: CreateWireServices<
-    CoreSingletonServices,
-    CoreServices<CoreSingletonServices>,
-    CoreUserSession
-  >
 }
 
 export type JsonRpcError = {
@@ -197,8 +189,10 @@ async function runMCPPikkuFunc(
   name: string,
   mcp: CoreMCPResource | CoreMCPPrompt | undefined,
   pikkuFuncId: string | undefined,
-  { singletonServices, createWireServices, mcp: mcpWire }: RunMCPEndpointParams
+  { mcp: mcpWire }: RunMCPEndpointParams
 ): Promise<JsonRpcResponse> {
+  const singletonServices = getSingletonServices()
+  const createWireServices = getCreateWireServices()
   let wireServices: any
 
   try {

package/src/wirings/mcp/mcp.types.ts

@@ -1,10 +1,10 @@
-import {
+import type {
   CorePermissionGroup,
   CorePikkuFunctionConfig,
   CorePikkuFunctionSessionless,
   CorePikkuPermission,
 } from '../../function/functions.types.js'
-import {
+import type {
   CorePikkuMiddleware,
   MiddlewareMetadata,
   PermissionMetadata,

package/src/wirings/oauth2/oauth2-client.ts

@@ -1,6 +1,6 @@
-import { OAuth2Token, OAuth2AppCredential } from './oauth2.types.js'
-import { OAuth2CredentialConfig } from '../secret/secret.types.js'
-import { SecretService } from '../../services/secret-service.js'
+import type { OAuth2Token, OAuth2AppCredential } from './oauth2.types.js'
+import type { OAuth2CredentialConfig } from '../secret/secret.types.js'
+import type { SecretService } from '../../services/secret-service.js'
 
 /**
  * OAuth2 client that acts as a service.

package/src/wirings/oauth2/wire-oauth2-credential.ts

@@ -1,4 +1,4 @@
-import { CoreOAuth2Credential } from './oauth2.types.js'
+import type { CoreOAuth2Credential } from './oauth2.types.js'
 
 /**
  * No-op function for declaring OAuth2 credentials.

package/src/wirings/queue/index.ts

@@ -16,7 +16,6 @@ export type {
 export {
   wireQueueWorker,
   runQueueJob,
-  createQueueJobRunner,
   getQueueWorkers,
   removeQueueWorker,
   QueueJobDiscardedError,

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

@@ -5,12 +5,11 @@ import {
   getQueueWorkers,
   removeQueueWorker,
   runQueueJob,
-  createQueueJobRunner,
   QueueJobFailedError,
   QueueJobDiscardedError,
 } from './queue-runner.js'
 import { resetPikkuState, pikkuState } from '../../pikku-state.js'
-import { CoreQueueWorker, QueueJob } from './queue.types.js'
+import type { CoreQueueWorker, QueueJob } from './queue.types.js'
 
 beforeEach(() => {
   resetPikkuState()
@@ -219,12 +218,14 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('simple-queue', 'job-123', {
       message: 'test data',
     })
 
     const result = await runQueueJob({
-      singletonServices: { logger: mockLogger } as any,
       job,
     })
 
@@ -257,12 +258,14 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('fail-queue', 'job-fail-123')
 
     await assert.rejects(
       async () => {
         await runQueueJob({
-          singletonServices: { logger: mockLogger } as any,
           job,
         })
       },
@@ -295,12 +298,14 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('fail-no-reason-queue', 'job-456')
 
     await assert.rejects(
       async () => {
         await runQueueJob({
-          singletonServices: { logger: mockLogger } as any,
           job,
         })
       },
@@ -331,12 +336,14 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('discard-queue', 'job-discard-789')
 
     await assert.rejects(
       async () => {
         await runQueueJob({
-          singletonServices: { logger: mockLogger } as any,
           job,
         })
       },
@@ -374,10 +381,12 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('progress-queue', 'job-progress-999')
 
     await runQueueJob({
-      singletonServices: { logger: mockLogger } as any,
       job,
       updateProgress: async (progress) => {
         progressUpdates.push(progress)
@@ -407,10 +416,12 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('default-progress-queue', 'job-111')
 
     await runQueueJob({
-      singletonServices: { logger: mockLogger } as any,
       job,
     })
 
@@ -441,10 +452,12 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('wire-queue', 'job-int-123')
 
     await runQueueJob({
-      singletonServices: { logger: mockLogger } as any,
       job,
     })
 
@@ -457,12 +470,14 @@ describe('runQueueJob', () => {
 
   test('should throw error when processor metadata not found', async () => {
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('missing-meta-queue', 'job-222')
 
     await assert.rejects(
       async () => {
         await runQueueJob({
-          singletonServices: { logger: mockLogger } as any,
           job,
         })
       },
@@ -483,12 +498,14 @@ describe('runQueueJob', () => {
     }
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('no-registration-queue', 'job-333')
 
     await assert.rejects(
       async () => {
         await runQueueJob({
-          singletonServices: { logger: mockLogger } as any,
           job,
         })
       },
@@ -520,15 +537,19 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
-    const job = createMockJob('session-services-queue', 'job-444')
-
-    await runQueueJob({
-      singletonServices: { logger: mockLogger } as any,
-      job,
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
+    pikkuState(null, 'package', 'factories', {
       createWireServices: async () => {
         createWireServicesCalled = true
         return mockWireService as any
       },
+    } as any)
+    const job = createMockJob('session-services-queue', 'job-444')
+
+    await runQueueJob({
+      job,
     })
 
     assert.equal(createWireServicesCalled, true)
@@ -553,12 +574,14 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('error-queue', 'job-555')
 
     await assert.rejects(
       async () => {
         await runQueueJob({
-          singletonServices: { logger: mockLogger } as any,
           job,
         })
       },
@@ -602,10 +625,12 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('middleware-queue', 'job-666')
 
     await runQueueJob({
-      singletonServices: { logger: mockLogger } as any,
       job,
     })
 
@@ -629,10 +654,12 @@ describe('runQueueJob', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
     const job = createMockJob('debug-queue', 'job-777')
 
     await runQueueJob({
-      singletonServices: { logger: mockLogger } as any,
       job,
     })
 
@@ -643,8 +670,8 @@ describe('runQueueJob', () => {
   })
 })
 
-describe('createQueueJobRunner', () => {
-  test('delegates queue job execution using bound services', async () => {
+describe('runQueueJob with pikkuState services', () => {
+  test('delegates queue job execution using pikkuState services', async () => {
     const mockWorker: CoreQueueWorker = {
       name: 'bound-runner-queue',
       func: {
@@ -663,11 +690,11 @@ describe('createQueueJobRunner', () => {
     wireQueueWorker(mockWorker)
 
     const mockLogger = createMockLogger()
-    const runJob = createQueueJobRunner({
-      singletonServices: { logger: mockLogger } as any,
-    })
+    pikkuState(null, 'package', 'singletonServices', {
+      logger: mockLogger,
+    } as any)
 
-    await runJob({
+    await runQueueJob({
       job: createMockJob('bound-runner-queue', 'job-888', { value: 41 }),
     })