@pikku/core 0.6.13 → 0.6.15

package/dist/middleware/index.d.ts

@@ -0,0 +1,4 @@
+export * from './auth-api-key.js';
+export * from './auth-cookie-middleware.js';
+export * from './auth-jwt-middleware.js';
+export * from './auth-query-middleware.js';

package/dist/middleware/index.js

@@ -0,0 +1,4 @@
+export * from './auth-api-key.js';
+export * from './auth-cookie-middleware.js';
+export * from './auth-jwt-middleware.js';
+export * from './auth-query-middleware.js';

package/dist/middleware-runner.d.ts

@@ -0,0 +1,22 @@
+import { UserSessionService } from './services/user-session-service.js';
+import { CoreSingletonServices, PikkuInteraction, PikkuMiddleware } from './types/core.types.js';
+/**
+ * Runs a chain of middleware functions in sequence before executing the main function.
+ *
+ * @param services - An object containing services (e.g., singletonServices, userSessionService, etc.)
+ * @param interaction - The interaction context, e.g., { http }.
+ * @param middlewares - An array of middleware functions to run.
+ * @param main - The main function to execute after all middleware have run.
+ * @returns A promise resolving to the result of the main function.
+ *
+ * @example
+ * runMiddleware(
+ *   { ...services, userSessionService },
+ *   { http },
+ *   [middleware1, middleware2, middleware3],
+ *   async () => { return await runMain(); }
+ * );
+ */
+export declare const runMiddleware: (services: CoreSingletonServices & {
+    userSessionService: UserSessionService<any>;
+}, interaction: PikkuInteraction, middlewares: PikkuMiddleware[], main?: () => Promise<void>) => Promise<void>;

package/dist/middleware-runner.js

@@ -0,0 +1,28 @@
+/**
+ * Runs a chain of middleware functions in sequence before executing the main function.
+ *
+ * @param services - An object containing services (e.g., singletonServices, userSessionService, etc.)
+ * @param interaction - The interaction context, e.g., { http }.
+ * @param middlewares - An array of middleware functions to run.
+ * @param main - The main function to execute after all middleware have run.
+ * @returns A promise resolving to the result of the main function.
+ *
+ * @example
+ * runMiddleware(
+ *   { ...services, userSessionService },
+ *   { http },
+ *   [middleware1, middleware2, middleware3],
+ *   async () => { return await runMain(); }
+ * );
+ */
+export const runMiddleware = async (services, interaction, middlewares, main) => {
+    const dispatch = async (index) => {
+        if (middlewares && index < middlewares.length) {
+            await middlewares[index](services, interaction, () => dispatch(index + 1));
+        }
+        else if (main) {
+            return await main();
+        }
+    };
+    await dispatch(0);
+};

package/dist/scheduler/scheduler.types.d.ts

@@ -8,6 +8,7 @@ export type ScheduledTasksMeta<UserSession extends CoreUserSession = any> = Arra
     schedule: string;
     session?: UserSession;
     docs?: APIDocs;
+    tags?: string[];
 }>;
 /**
  * Represents a core scheduled task.
@@ -18,4 +19,5 @@ export type CoreScheduledTask<APIFunction = CoreAPIFunctionSessionless<void, voi
     func: APIFunction;
     docs?: APIDocs;
     session?: UserSession;
+    tags?: string[];
 };

package/dist/schema.d.ts

@@ -23,4 +23,4 @@ export declare const addSchema: (name: string, value: any) => void;
  */
 export declare const compileAllSchemas: (logger: Logger, schemaService?: SchemaService) => void;
 export declare const coerceQueryStringToArray: (schemaName: string, data: any) => void;
-export declare const validateAndCoerce: (logger: Logger, schemaService: SchemaService | undefined, schemaName: string | undefined | null, data: any, coerceToArray: boolean) => void;
+export declare const validateSchema: (logger: Logger, schemaService: SchemaService | undefined, schemaName: string | undefined | null, data: any) => Promise<void>;

package/dist/schema.js

@@ -79,7 +79,7 @@ export const coerceQueryStringToArray = (schemaName, data) => {
         }
     }
 };
-export const validateAndCoerce = (logger, schemaService, schemaName, data, coerceToArray) => {
+export const validateSchema = async (logger, schemaService, schemaName, data) => {
     if (schemaService) {
         if (!schemaName) {
             if (data && (data.length > 0 || Object.keys(data).length > 0)) {
@@ -91,10 +91,7 @@ export const validateAndCoerce = (logger, schemaService, schemaName, data, coerc
             }
         }
         const schema = getSchema(schemaName);
-        schemaService.compileSchema(schemaName, schema);
-        if (coerceToArray) {
-            coerceQueryStringToArray(schemaName, data);
-        }
-        schemaService.validateSchema(schemaName, data);
+        await schemaService.compileSchema(schemaName, schema);
+        await schemaService.validateSchema(schemaName, data);
     }
 };

package/dist/services/index.d.ts

@@ -8,5 +8,6 @@ export * from './logger-console.js';
 export * from './secret-service.js';
 export * from './variables-service.js';
 export * from './schema-service.js';
+export * from './user-session-service.js';
 export * from './local-secrets.js';
 export * from './local-variables.js';

package/dist/services/index.js

@@ -9,6 +9,7 @@ export * from './logger-console.js';
 export * from './secret-service.js';
 export * from './variables-service.js';
 export * from './schema-service.js';
+export * from './user-session-service.js';
 // Local implementations
 export * from './local-secrets.js';
 export * from './local-variables.js';

package/dist/services/user-session-service.d.ts

@@ -1,6 +1,23 @@
+import { ChannelStore } from '../channel/channel-store.js';
 import { CoreUserSession } from '../types/core.types.js';
 export interface UserSessionService<UserSession extends CoreUserSession> {
-    setSession: (session: UserSession) => Promise<void> | void;
-    deleteSession: () => Promise<void> | void;
-    getSession: () => Promise<UserSession | void> | UserSession | void;
+    set(session: UserSession): Promise<void> | void;
+    clear(): Promise<void> | void;
+    get(): Promise<UserSession | undefined> | UserSession | undefined;
+}
+export declare class LocalUserSessionService<UserSession extends CoreUserSession> implements UserSessionService<UserSession> {
+    private session;
+    constructor(session?: UserSession | undefined);
+    set(session: UserSession): void;
+    clear(): void;
+    get(): UserSession | undefined;
+}
+export declare class RemoteUserSessionService<UserSession extends CoreUserSession> implements UserSessionService<UserSession> {
+    private channelStore;
+    private channelId;
+    session: UserSession | undefined;
+    constructor(channelStore: ChannelStore<unknown, unknown, UserSession>, channelId: string, session?: UserSession | undefined);
+    set(session: UserSession): Promise<void>;
+    clear(): Promise<void>;
+    get(): Promise<UserSession | undefined>;
 }

package/dist/services/user-session-service.js

@@ -1 +1,35 @@
-export {};
+export class LocalUserSessionService {
+    session;
+    constructor(session = undefined) {
+        this.session = session;
+    }
+    set(session) {
+        this.session = session;
+    }
+    clear() {
+        this.session = undefined;
+    }
+    get() {
+        return this.session;
+    }
+}
+export class RemoteUserSessionService {
+    channelStore;
+    channelId;
+    session;
+    constructor(channelStore, channelId, session = undefined) {
+        this.channelStore = channelStore;
+        this.channelId = channelId;
+        this.session = session;
+    }
+    async set(session) {
+        await this.channelStore.setUserSession(this.channelId, session);
+    }
+    async clear() {
+        await this.channelStore.setUserSession(this.channelId, undefined);
+    }
+    async get() {
+        const channel = await this.channelStore.getChannel(this.channelId);
+        return channel.userSession;
+    }
+}

package/dist/types/core.types.d.ts

@@ -1,10 +1,8 @@
 import type { Logger, LogLevel } from '../services/logger.js';
-import type { HTTPSessionService } from '../http/http-session-service.js';
 import { VariablesService } from '../services/variables-service.js';
 import { EventHubService } from '../channel/eventhub-service.js';
 import { SchemaService } from '../services/schema-service.js';
-import { enforceChannelAccess } from '../channel/channel.types.js';
-import { enforceHTTPAccess, PikkuHTTP } from '../http/http-routes.types.js';
+import { PikkuHTTP } from '../http/http-routes.types.js';
 import { UserSessionService } from '../services/user-session-service.js';
 import { JWTService } from '../services/jwt-service.js';
 import { SecretService } from '../services/secret-service.js';
@@ -39,8 +37,6 @@ export type RequireAtLeastOne<T> = {
 export type CoreConfig<Config extends Record<string, unknown> = {}> = {
     /** The log level for the application. */
     logLevel?: LogLevel;
-    /** The maximum compute time allowed, in milliseconds (optional). */
-    maximumComputeTime?: number;
     /** Secrets used by the application (optional). */
     secrets?: {};
 } & Config;
@@ -53,14 +49,8 @@ export interface CoreUserSession {
  * Interface for core singleton services provided by Pikku.
  */
 export interface CoreSingletonServices<Config extends CoreConfig = CoreConfig, UserSession extends CoreUserSession = CoreUserSession> {
-    /** The http permission service used for authorization (optional). */
-    enforceHTTPAccess?: enforceHTTPAccess;
-    /** The channel permission service used by the application (optional). */
-    enforceChannelAccess?: enforceChannelAccess;
     /** JWT Service */
     jwt?: JWTService<UserSession>;
-    /** The session service used by the application (optional). */
-    httpSessionService?: HTTPSessionService;
     /** The schema library used to validate data */
     schemaService?: SchemaService;
     /** The core configuration for the application. */
@@ -77,16 +67,22 @@ export interface CoreSingletonServices<Config extends CoreConfig = CoreConfig, U
 /**
  * Represents different forms of interaction within Pikku and the outside world.
  */
-export interface PikkuInteractions {
+export interface PikkuInteraction {
     http?: PikkuHTTP;
 }
+/**
+ * A function that can wrap an interaction and be called before or after
+ */
+export type PikkuMiddleware<SingletonServices extends CoreSingletonServices = CoreSingletonServices, UserSession extends CoreUserSession = CoreUserSession> = (services: SingletonServices & {
+    userSessionService: UserSessionService<UserSession>;
+}, interactions: PikkuInteraction, next: () => Promise<void>) => Promise<void>;
 /**
  * Represents the core services used by Pikku, including singleton services and the request/response interaction.
  */
-export type CoreServices<SingletonServices = CoreSingletonServices, UserSession extends CoreUserSession = CoreUserSession, CoreServices extends Record<string, unknown> = {}> = SingletonServices & PikkuInteractions & {
+export type CoreServices<SingletonServices = CoreSingletonServices, UserSession extends CoreUserSession = CoreUserSession, CoreServices extends Record<string, unknown> = {}> = SingletonServices & PikkuInteraction & {
     userSession?: UserSessionService<UserSession>;
 } & CoreServices;
-export type SessionServices<SingletonServices extends CoreSingletonServices = CoreSingletonServices, Services = CoreServices<SingletonServices>> = Omit<Services, keyof SingletonServices | keyof PikkuInteractions | 'session'>;
+export type SessionServices<SingletonServices extends CoreSingletonServices = CoreSingletonServices, Services = CoreServices<SingletonServices>> = Omit<Services, keyof SingletonServices | keyof PikkuInteraction | 'session'>;
 /**
  * Defines a function type for creating singleton services from the given configuration.
  */
@@ -94,7 +90,7 @@ export type CreateSingletonServices<Config extends CoreConfig, SingletonServices
 /**
  * Defines a function type for creating session-specific services.
  */
-export type CreateSessionServices<SingletonServices extends CoreSingletonServices = CoreSingletonServices, Services extends CoreServices<SingletonServices> = CoreServices<SingletonServices>, UserSession extends CoreUserSession = CoreUserSession> = (services: SingletonServices, interaction: PikkuInteractions, session: UserSession | undefined) => Promise<SessionServices<Services, SingletonServices>>;
+export type CreateSessionServices<SingletonServices extends CoreSingletonServices = CoreSingletonServices, Services extends CoreServices<SingletonServices> = CoreServices<SingletonServices>, UserSession extends CoreUserSession = CoreUserSession> = (services: SingletonServices, interaction: PikkuInteraction, session: UserSession | undefined) => Promise<SessionServices<Services, SingletonServices>>;
 /**
  * Defines a function type for creating config.
  */

package/dist/types/functions.types.d.ts

@@ -1,4 +1,4 @@
-import type { CoreServices, CoreUserSession } from './core.types.js';
+import type { CoreServices, CoreSingletonServices, CoreUserSession } from './core.types.js';
 /**
  * Represents a core API function that performs an operation using core services and a user session.
  *
@@ -7,7 +7,7 @@ import type { CoreServices, CoreUserSession } from './core.types.js';
  * @template Services - The services type, defaults to `CoreServices`.
  * @template Session - The session type, defaults to `CoreUserSession`.
  */
-export type CoreAPIFunction<In, Out, Services = CoreServices, Session = CoreUserSession> = (services: Services, data: In, session: Session) => Promise<Out>;
+export type CoreAPIFunction<In, Out, Services extends CoreSingletonServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session: Session) => Promise<Out>;
 /**
  * Represents a core API function that can be used without a session.
  *
@@ -16,7 +16,7 @@ export type CoreAPIFunction<In, Out, Services = CoreServices, Session = CoreUser
  * @template Services - The services type, defaults to `CoreServices`.
  * @template Session - The session type, defaults to `CoreUserSession`.
  */
-export type CoreAPIFunctionSessionless<In, Out, Services = CoreServices, Session = CoreUserSession> = (services: Services, data: In, session?: Session) => Promise<Out>;
+export type CoreAPIFunctionSessionless<In, Out, Services extends CoreSingletonServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session?: Session) => Promise<Out>;
 /**
  * Represents a function that checks permissions for a given API operation.
  *
@@ -24,4 +24,4 @@ export type CoreAPIFunctionSessionless<In, Out, Services = CoreServices, Session
  * @template Services - The services type, defaults to `CoreServices`.
  * @template Session - The session type, defaults to `CoreUserSession`.
  */
-export type CoreAPIPermission<In = any, Services = CoreServices, Session = CoreUserSession> = (services: Services, data: In, session?: Session) => Promise<boolean>;
+export type CoreAPIPermission<In = any, Services extends CoreSingletonServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session?: Session) => Promise<boolean>;