@pikku/core 0.8.1 → 0.9.0

package/dist/{events → wirings}/http/http.types.d.ts

@@ -1,10 +1,15 @@
 import type { SerializeOptions } from 'cookie';
 import type { PikkuError } from '../../errors/error-handler.js';
 import type { APIDocs, CoreServices, CoreSingletonServices, CoreUserSession, CreateSessionServices, PikkuMiddleware } from '../../types/core.types.js';
-import type { CoreAPIFunction, CoreAPIFunctionSessionless, CoreAPIPermission, CorePermissionGroup } from '../../function/functions.types.js';
-type ExtractRouteParams<S extends string> = S extends `${string}:${infer Param}/${infer Rest}` ? Param | ExtractRouteParams<`/${Rest}`> : S extends `${string}:${infer Param}` ? Param : never;
-export type AssertRouteParams<In, Route extends string> = ExtractRouteParams<Route> extends keyof In ? unknown : ['Error: Route parameters', ExtractRouteParams<Route>, 'not in', keyof In];
-export type RunRouteOptions = Partial<{
+import type { CorePikkuFunction, CorePikkuFunctionSessionless, CorePikkuPermission, CorePermissionGroup } from '../../function/functions.types.js';
+type ExtractHTTPWiringParams<S extends string> = S extends `${string}:${infer Param}/${infer Rest}` ? Param | ExtractHTTPWiringParams<`/${Rest}`> : S extends `${string}:${infer Param}` ? Param : never;
+export type AssertHTTPWiringParams<In, HTTPWiring extends string> = ExtractHTTPWiringParams<HTTPWiring> extends keyof In ? unknown : [
+    'Error: HTTPWiring parameters',
+    ExtractHTTPWiringParams<HTTPWiring>,
+    'not in',
+    keyof In
+];
+export type RunHTTPWiringOptions = Partial<{
     skipUserSession: boolean;
     respondWith404: boolean;
     logWarningsForStatusCodes: number[];
@@ -13,16 +18,16 @@ export type RunRouteOptions = Partial<{
     generateRequestId: () => string;
     ignoreMiddleware: boolean;
 }>;
-export type RunRouteParams = {
+export type RunHTTPWiringParams = {
     singletonServices: CoreSingletonServices;
     createSessionServices: CreateSessionServices<CoreSingletonServices, CoreServices<CoreSingletonServices>, CoreUserSession>;
 };
 /**
- * Represents the HTTP methods supported for API routes.
- */
+ * Represents the HTTP methods supported for API HTTP wirings.
+t */
 export type HTTPMethod = 'post' | 'get' | 'delete' | 'patch' | 'head' | 'put' | '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';
@@ -53,20 +58,20 @@ export type RequestHeaders = Record<string, string | string[] | undefined> | ((h
  */
 export type PikkuQuery<T = Record<string, string | undefined>> = Record<string, string | T | null | Array<T | null>>;
 /**
- * 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<In, Out, R extends string, APIFunction = CoreAPIFunction<In, Out>, APIFunctionSessionless = CoreAPIFunctionSessionless<In, Out>, APIPermission = CoreAPIPermission<In>, APIMiddleware = PikkuMiddleware> = (CoreHTTPFunction & {
+export type CoreHTTPFunctionWiring<In, Out, R extends string, 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[];
@@ -74,7 +79,7 @@ export type CoreHTTPFunctionRoute<In, Out, R extends string, APIFunction = CoreA
 }) | (CoreHTTPFunction & {
     route: R;
     method: HTTPMethod;
-    func: APIFunctionSessionless;
+    func: PikkuFunctionSessionless;
     permissions?: undefined;
     auth?: false;
     tags?: string[];
@@ -83,8 +88,8 @@ export type CoreHTTPFunctionRoute<In, Out, R extends string, APIFunction = CoreA
 }) | (CoreHTTPFunction & {
     route: R;
     method: 'get';
-    func: APIFunction;
-    permissions?: CorePermissionGroup<APIPermission>;
+    func: PikkuFunction;
+    permissions?: CorePermissionGroup<PikkuPermission>;
     auth?: true;
     sse?: boolean;
     tags?: string[];
@@ -92,7 +97,7 @@ export type CoreHTTPFunctionRoute<In, Out, R extends string, APIFunction = CoreA
 }) | (CoreHTTPFunction & {
     route: R;
     method: 'get';
-    func: APIFunctionSessionless;
+    func: PikkuFunctionSessionless;
     permissions?: undefined;
     auth?: false;
     sse?: boolean;
@@ -101,8 +106,8 @@ export type CoreHTTPFunctionRoute<In, Out, R extends string, APIFunction = CoreA
 }) | (CoreHTTPFunction & {
     route: R;
     method: 'post';
-    func: APIFunction;
-    permissions?: CorePermissionGroup<APIPermission>;
+    func: PikkuFunction;
+    permissions?: CorePermissionGroup<PikkuPermission>;
     auth?: true;
     query?: Array<keyof In>;
     tags?: string[];
@@ -111,7 +116,7 @@ export type CoreHTTPFunctionRoute<In, Out, R extends string, APIFunction = CoreA
 }) | (CoreHTTPFunction & {
     route: R;
     method: 'post';
-    func: APIFunctionSessionless;
+    func: PikkuFunctionSessionless;
     permissions?: undefined;
     auth?: false;
     query?: Array<keyof In>;
@@ -120,7 +125,7 @@ export type CoreHTTPFunctionRoute<In, Out, R extends string, APIFunction = CoreA
     sse?: undefined;
 });
 /**
- * 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;
@@ -128,9 +133,9 @@ export type HTTPFunctionMetaInputTypes = {
     body?: string;
 };
 /**
- * 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;
@@ -141,13 +146,13 @@ export type HTTPRouteMeta = {
     tags?: string[];
     sse?: true;
 };
-export type HTTPRoutesMeta = Array<HTTPRouteMeta>;
+export type HTTPWiringsMeta = Array<HTTPWiringMeta>;
 export type HTTPFunctionsMeta = Array<{
     name: string;
     inputs: string[] | null;
     outputs: string[] | null;
 }>;
-export type HTTPRouteMiddleware = {
+export type HTTPWiringMiddleware = {
     route: string;
     middleware: PikkuMiddleware[];
 };

package/dist/{events → wirings}/http/index.d.ts

@@ -1,5 +1,5 @@
 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/dist/{events → wirings}/http/index.js

@@ -1,4 +1,4 @@
 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';

package/dist/{events → wirings}/mcp/mcp-endpoint-registry.d.ts

@@ -28,7 +28,6 @@ export declare class MCPEndpointRegistry {
     private resourcesMeta;
     private toolsMeta;
     private promptsMeta;
-    loadFromMCPJsonFile(mcpJsonPath: string): Promise<void>;
     loadFromMCPJson(mcpData: any): Promise<void>;
     setResourcesMeta(meta: MCPResourceMeta): void;
     setToolsMeta(meta: MCPToolMeta): void;

package/dist/{events → wirings}/mcp/mcp-endpoint-registry.js

@@ -1,4 +1,3 @@
-import { readFile } from 'fs/promises';
 export class MCPEndpointRegistry {
     tools = new Map();
     resources = new Map();
@@ -6,15 +5,6 @@ export class MCPEndpointRegistry {
     resourcesMeta = {};
     toolsMeta = {};
     promptsMeta = {};
-    async loadFromMCPJsonFile(mcpJsonPath) {
-        try {
-            const mcpJsonContent = await readFile(mcpJsonPath, 'utf-8');
-            await this.loadFromMCPJson(JSON.parse(mcpJsonContent));
-        }
-        catch (error) {
-            throw new Error(`Failed to load MCP JSON from ${mcpJsonPath}: ${error}`);
-        }
-    }
     async loadFromMCPJson(mcpData) {
         if (mcpData.tools && Array.isArray(mcpData.tools)) {
             for (const tool of mcpData.tools) {

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

@@ -1,6 +1,6 @@
 import type { CoreServices, CoreSingletonServices, CoreUserSession, CreateSessionServices } from '../../types/core.types.js';
 import type { CoreMCPResource, CoreMCPTool, CoreMCPPrompt, JsonRpcRequest, JsonRpcResponse, JsonRpcErrorResponse, PikkuMCP } from './mcp.types.js';
-import type { CoreAPIFunctionSessionless } from '../../function/functions.types.js';
+import type { CorePikkuFunctionSessionless } from '../../function/functions.types.js';
 export declare class MCPError extends Error {
     readonly error: JsonRpcErrorResponse;
     constructor(error: JsonRpcErrorResponse);
@@ -16,9 +16,9 @@ export type JsonRpcError = {
     message: string;
     data?: any;
 };
-export declare const addMCPResource: <APIFunction extends CoreAPIFunctionSessionless<any, any>>(mcpResource: CoreMCPResource<APIFunction>) => void;
-export declare const addMCPTool: <APIFunction extends CoreAPIFunctionSessionless<any, any>>(mcpTool: CoreMCPTool<APIFunction>) => void;
-export declare const addMCPPrompt: <APIFunction extends CoreAPIFunctionSessionless<any, any>>(mcpPrompt: CoreMCPPrompt<APIFunction>) => void;
+export declare const wireMCPResource: <PikkuFunction extends CorePikkuFunctionSessionless<any, any>>(mcpResource: CoreMCPResource<PikkuFunction>) => void;
+export declare const wireMCPTool: <PikkuFunction extends CorePikkuFunctionSessionless<any, any>>(mcpTool: CoreMCPTool<PikkuFunction>) => void;
+export declare const wireMCPPrompt: <PikkuFunction extends CorePikkuFunctionSessionless<any, any>>(mcpPrompt: CoreMCPPrompt<PikkuFunction>) => void;
 export declare function runMCPResource(request: JsonRpcRequest, params: RunMCPEndpointParams, uri: string): Promise<JsonRpcResponse>;
 export declare function runMCPTool(request: JsonRpcRequest, params: RunMCPEndpointParams, name: string): Promise<JsonRpcResponse>;
 export declare function runMCPPrompt(request: JsonRpcRequest, params: RunMCPEndpointParams, name: string): Promise<JsonRpcResponse>;

package/dist/{events → wirings}/mcp/mcp-runner.js

@@ -13,7 +13,7 @@ export class MCPError extends Error {
         this.stack = new Error().stack;
     }
 }
-export const addMCPResource = (mcpResource) => {
+export const wireMCPResource = (mcpResource) => {
     const resourcesMeta = pikkuState('mcp', 'resourcesMeta');
     const mcpResourceMeta = resourcesMeta[mcpResource.uri];
     if (!mcpResourceMeta) {
@@ -28,7 +28,7 @@ export const addMCPResource = (mcpResource) => {
     }
     resources.set(mcpResource.uri, mcpResource);
 };
-export const addMCPTool = (mcpTool) => {
+export const wireMCPTool = (mcpTool) => {
     const toolsMeta = pikkuState('mcp', 'toolsMeta');
     const mcpToolMeta = toolsMeta[mcpTool.name];
     if (!mcpToolMeta) {
@@ -43,11 +43,11 @@ export const addMCPTool = (mcpTool) => {
     }
     tools.set(mcpTool.name, mcpTool);
 };
-export const addMCPPrompt = (mcpPrompt) => {
+export const wireMCPPrompt = (mcpPrompt) => {
     const promptsMeta = pikkuState('mcp', 'promptsMeta');
     const mcpPromptMeta = promptsMeta[mcpPrompt.name];
     if (!mcpPromptMeta) {
-        throw new Error(`MCP prompt metadata not found for '${mcpPrompt.name}'`);
+        throw new Error(`MCP prompt metadata not found for '${mcpPrompt.name}' ${JSON.stringify(promptsMeta)}`);
     }
     addFunction(mcpPromptMeta.pikkuFuncName, {
         func: mcpPrompt.func,

package/dist/{events → wirings}/mcp/mcp.types.d.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> = {
     uri?: string;
     sendResourceUpdated: (uri: string) => void;
@@ -38,35 +38,35 @@ export type MCPPromptMeta = Record<string, Omit<CoreMCPPrompt, 'func'> & {
 /**
  * Represents an MCP resource with specific properties.
  */
-export type CoreMCPResource<APIFunction = CoreAPIFunctionSessionless<any, any>> = {
+export type CoreMCPResource<PikkuFunction = CorePikkuFunctionSessionless<any, any>> = {
     uri: string;
     title: string;
     description?: string;
     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;
 };
 /**
  * Represents an MCP prompt with specific properties.
  */
-export type CoreMCPPrompt<APIFunction = CoreAPIFunctionSessionless<any, MCPPromptResponse>> = {
+export type CoreMCPPrompt<PikkuFunction = CorePikkuFunctionSessionless<any, MCPPromptResponse>> = {
     name: string;
     description?: string;
-    func: APIFunction;
+    func: PikkuFunction;
     tags?: string[];
 };
 export type JsonRpcRequest = {

package/dist/{events → wirings}/queue/index.d.ts

@@ -1,5 +1,5 @@
 export type * from './queue.types.js';
-export { addQueueWorker, runQueueJob, getQueueWorkers, removeQueueWorker, } from './queue-runner.js';
+export { wireQueueWorker, runQueueJob, getQueueWorkers, removeQueueWorker, } from './queue-runner.js';
 export { validateWorkerConfig } from './validate-worker-config.js';
 export type { QueueConfigMapping } from './validate-worker-config.js';
 export { registerQueueWorkers } from './register-queue-helper.js';

package/dist/{events → wirings}/queue/index.js

@@ -1,5 +1,5 @@
 // Queue processor management
-export { addQueueWorker, runQueueJob, getQueueWorkers, removeQueueWorker, } from './queue-runner.js';
+export { wireQueueWorker, runQueueJob, getQueueWorkers, removeQueueWorker, } from './queue-runner.js';
 // Configuration validation
 export { validateWorkerConfig } from './validate-worker-config.js';
 // Queue registration helper

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

@@ -1,11 +1,11 @@
 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 { CreateSessionServices } from '../../types/core.types.js';
 /**
  * Add a queue processor to the system
  */
-export declare const addQueueWorker: <InputData = any, OutputData = any, APIFunction extends CoreAPIFunctionSessionless<InputData, OutputData> = CoreAPIFunctionSessionless<InputData, OutputData>>(queueWorker: CoreQueueWorker<APIFunction>) => void;
+export declare const wireQueueWorker: <InputData = any, OutputData = any, PikkuFunction extends CorePikkuFunctionSessionless<InputData, OutputData> = CorePikkuFunctionSessionless<InputData, OutputData>>(queueWorker: CoreQueueWorker<PikkuFunction>) => void;
 /**
  * Get all registered queue processors
  */

package/dist/{events → wirings}/queue/queue-runner.js

@@ -12,7 +12,7 @@ class QueueWorkerNotFoundError extends Error {
 /**
  * Add a queue processor to the system
  */
-export const addQueueWorker = (queueWorker) => {
+export const wireQueueWorker = (queueWorker) => {
     // Get processor metadata
     const meta = pikkuState('queue', 'meta');
     const processorMeta = meta[queueWorker.queueName];

package/dist/{events → wirings}/queue/queue.types.d.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';
 /**
  * Configuration for queue workers - how jobs are processed
@@ -144,9 +144,9 @@ export type queueWorkersMeta = Record<string, {
 /**
  * Core queue processor definition
  */
-export type CoreQueueWorker<APIFunction = CoreAPIFunctionSessionless<any, any>> = {
+export type CoreQueueWorker<PikkuFunction = CorePikkuFunctionSessionless<any, any>> = {
     queueName: string;
-    func: APIFunction;
+    func: PikkuFunction;
     config?: PikkuWorkerConfig;
     docs?: APIDocs;
     session?: undefined;

package/dist/wirings/scheduler/index.d.ts

@@ -0,0 +1,3 @@
+export * from './scheduler.types.js';
+export { runScheduledTask, wireScheduler, getScheduledTasks, } from './scheduler-runner.js';
+export * from './log-schedulers.js';

package/dist/wirings/scheduler/index.js

@@ -0,0 +1,3 @@
+export * from './scheduler.types.js';
+export { runScheduledTask, wireScheduler, getScheduledTasks, } from './scheduler-runner.js';
+export * from './log-schedulers.js';

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

@@ -1,12 +1,12 @@
 import type { CoreServices, CoreSingletonServices, CoreUserSession, 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';
 export type RunScheduledTasksParams = {
     name: string;
     session?: CoreUserSession;
     singletonServices: CoreSingletonServices;
     createSessionServices?: CreateSessionServices<CoreSingletonServices, CoreServices<CoreSingletonServices>, CoreUserSession>;
 };
-export declare const addScheduledTask: <APIFunction extends CoreAPIFunctionSessionless<void, void>>(scheduledTask: CoreScheduledTask<APIFunction>) => void;
+export declare const wireScheduler: <PikkuFunction extends CorePikkuFunctionSessionless<void, void>>(scheduledTask: CoreScheduledTask<PikkuFunction>) => void;
 export declare function runScheduledTask({ name, session, singletonServices, createSessionServices, }: RunScheduledTasksParams): Promise<void>;
 export declare const getScheduledTasks: () => Map<string, CoreScheduledTask>;

package/dist/{events → wirings}/scheduler/scheduler-runner.js

@@ -3,7 +3,7 @@ import { closeSessionServices } from '../../utils.js';
 import { pikkuState } from '../../pikku-state.js';
 import { addFunction, runPikkuFunc } from '../../function/function-runner.js';
 import { rpcService } from '../rpc/rpc-runner.js';
-export const addScheduledTask = (scheduledTask) => {
+export const wireScheduler = (scheduledTask) => {
     const meta = pikkuState('scheduler', 'meta');
     const taskMeta = meta[scheduledTask.name];
     if (!taskMeta) {

package/dist/{events → wirings}/scheduler/scheduler.types.d.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.
  */
@@ -14,10 +14,10 @@ export type ScheduledTasksMeta<UserSession extends CoreUserSession = any> = Reco
 /**
  * Represents a core scheduled task.
  */
-export type CoreScheduledTask<APIFunction = CoreAPIFunctionSessionless<void, void>> = {
+export type CoreScheduledTask<PikkuFunction = CorePikkuFunctionSessionless<void, void>> = {
     name: string;
     schedule: string;
-    func: APIFunction;
+    func: PikkuFunction;
     docs?: APIDocs;
     tags?: string[];
 };