@pikku/core 0.6.27 → 0.7.0

package/dist/scheduler/scheduler-runner.js

@@ -1,7 +1,14 @@
 import { getErrorResponse } from '../errors/error-handler.js';
 import { closeSessionServices } from '../utils.js';
 import { pikkuState } from '../pikku-state.js';
+import { addFunction, runPikkuFunc } from '../function/function-runner.js';
 export const addScheduledTask = (scheduledTask) => {
+    const meta = pikkuState('scheduler', 'meta');
+    const taskMeta = meta[scheduledTask.name];
+    if (!taskMeta) {
+        throw new Error('Task metadata not found');
+    }
+    addFunction(taskMeta.pikkuFuncName, scheduledTask.func);
     const tasks = pikkuState('scheduler', 'tasks');
     if (tasks.has(scheduledTask.name)) {
         throw new Error(`Scheduled task already exists: ${scheduledTask.name}`);
@@ -17,16 +24,27 @@ export async function runScheduledTask({ name, session, singletonServices, creat
     let sessionServices;
     try {
         const task = pikkuState('scheduler', 'tasks').get(name);
+        const meta = pikkuState('scheduler', 'meta')[name];
         if (!task) {
             throw new ScheduledTaskNotFoundError(`Scheduled task not found: ${name}`);
         }
-        singletonServices.logger.info(`Running schedule task: ${name} | schedule: ${task.schedule}`);
-        let allServices = singletonServices;
-        if (createSessionServices) {
-            const sessionServices = await createSessionServices(singletonServices, {}, session);
-            allServices = { ...singletonServices, ...sessionServices };
+        if (!meta) {
+            throw new ScheduledTaskNotFoundError(`Scheduled task meta not found: ${name}`);
         }
-        await task.func(allServices, undefined, session);
+        singletonServices.logger.info(`Running schedule task: ${name} | schedule: ${task.schedule}`);
+        const getAllServices = async () => {
+            if (createSessionServices) {
+                const sessionServices = await createSessionServices(singletonServices, {}, session);
+                return { ...singletonServices, ...sessionServices };
+            }
+            return singletonServices;
+        };
+        return await runPikkuFunc(meta.pikkuFuncName, {
+            singletonServices,
+            getAllServices,
+            session,
+            data: undefined,
+        });
     }
     catch (e) {
         const errorResponse = getErrorResponse(e);

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

@@ -1,9 +1,10 @@
 import { APIDocs, CoreUserSession } from '../types/core.types.js';
-import { CoreAPIFunctionSessionless } from '../types/functions.types.js';
+import { CoreAPIFunctionSessionless } from '../function/functions.types.js';
 /**
  * Represents metadata for scheduled tasks, including title, schedule, and documentation.
  */
-export type ScheduledTasksMeta<UserSession extends CoreUserSession = any> = Array<{
+export type ScheduledTasksMeta<UserSession extends CoreUserSession = any> = Record<string, {
+    pikkuFuncName: string;
     name: string;
     schedule: string;
     session?: UserSession;

package/dist/services/content-service.d.ts

@@ -1,57 +1,53 @@
 import { ReadStream } from 'fs';
-import { Readable } from 'stream';
-/**
- * Interface for handling content operations.
- */
 export interface ContentService {
     /**
-     * Signs a content key to provide secure access.
-     * @param contentKey - The key of the content to sign.
-     * @returns A promise that resolves to the signed content key URL.
+     * Signs a content key to generate a secure, time-limited access URL.
+     * @param contentKey - The key representing the content object.
+     * @param dateLessThan - The expiration time for the signed URL.
+     * @param dateGreaterThan - (Optional) Start time before which access is denied.
      */
-    signContentKey: (contentKey: string, dateLessThan: Date, dateGreaterThan?: Date) => Promise<string>;
+    signContentKey(contentKey: string, dateLessThan: Date, dateGreaterThan?: Date): Promise<string>;
     /**
-     * Signs a URL to provide secure access.
-     * @param url - The URL to sign.
-     * @returns A promise that resolves to the signed URL.
+     * Signs an arbitrary URL to generate a secure, time-limited access URL.
+     * @param url - The full URL that needs signing.
+     * @param dateLessThan - The expiration time for the signed URL.
+     * @param dateGreaterThan - (Optional) Start time before which access is denied.
      */
-    signURL: (url: string, dateLessThan: Date, dateGreaterThan?: Date) => Promise<string>;
+    signURL(url: string, dateLessThan: Date, dateGreaterThan?: Date): Promise<string>;
     /**
-     * Gets an upload URL for a file.
-     * @param fileKey - The key of the file to upload.
-     * @param contentType - The content type of the file.
-     * @returns A promise that resolves to an object containing the upload URL and asset key.
-     *  This method generates an upload URL for the specified file key and content type, allowing the file to be uploaded.
+     * Generates a signed URL for uploading a file directly to storage.
+     * @param fileKey - The desired key/location of the uploaded file.
+     * @param contentType - The MIME type of the file.
+     * @returns A signed upload URL and the finalized asset key.
      */
-    getUploadURL: (fileKey: string, contentType: string) => Promise<{
+    getUploadURL(fileKey: string, contentType: string): Promise<{
         uploadUrl: string;
         assetKey: string;
     }>;
     /**
-     * Deletes a file.
-     * @param fileName - The name of the file to delete.
-     * @returns A promise that resolves to a boolean indicating success.
-     *  This method deletes the specified file and returns a boolean indicating whether the deletion was successful.
+     * Deletes a file from the storage backend.
+     * @param fileName - The name or key of the file to delete.
+     * @returns A boolean indicating success.
      */
-    deleteFile: (fileName: string) => Promise<boolean>;
+    deleteFile(fileName: string): Promise<boolean>;
     /**
-     * Writes a file.
-     * @param assetKey - The key of the asset to write.
-     * @param stream - The ReadStream of the file to write.
-     * @returns A promise that resolves to a boolean indicating success.
+     * Uploads a file stream to storage under a specified asset key.
+     * @param assetKey - The key where the file will be saved.
+     * @param stream - A readable stream of the file contents.
+     * @returns A boolean indicating success.
      */
-    writeFile: (assetKey: string, stream: ReadStream) => Promise<boolean>;
+    writeFile(assetKey: string, stream: ReadStream): Promise<boolean>;
     /**
-     * This method copies the file from the specified absolute path to the location identified by the asset key and returns a boolean indicating success.
-     * @param assetKey - The key of the asset to copy.
-     * @param fromAbsolutePath - The absolute path of the source file.
-     * @returns A promise that resolves to a boolean indicating success.
+     * Copies a file from a local absolute path into storage under a new asset key.
+     * @param assetKey - The destination key.
+     * @param fromAbsolutePath - The local absolute file path.
+     * @returns A boolean indicating success.
      */
-    copyFile: (assetKey: string, fromAbsolutePath: string) => Promise<boolean>;
+    copyFile(assetKey: string, fromAbsolutePath: string): Promise<boolean>;
     /**
-     * Reads a file.
-     * @param assetKey - The key of the asset to read.
-     * @returns A promise that resolves to a Readable stream of the file.
+     * Reads a file from storage as a readable stream.
+     * @param assetKey - The key of the file to read.
+     * @returns A readable file stream.
      */
-    readFile: (assetKey: string) => Promise<Readable>;
+    readFile(assetKey: string): Promise<ReadStream>;
 }

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

@@ -2,10 +2,23 @@ import type { Logger, LogLevel } from '../services/logger.js';
 import { VariablesService } from '../services/variables-service.js';
 import { EventHubService } from '../channel/eventhub-service.js';
 import { SchemaService } from '../services/schema-service.js';
-import { PikkuHTTP } from '../http/http-routes.types.js';
+import { PikkuHTTP } from '../http/http.types.js';
 import { UserSessionService } from '../services/user-session-service.js';
 import { JWTService } from '../services/jwt-service.js';
 import { SecretService } from '../services/secret-service.js';
+import { PikkuChannel } from '../channel/channel.types.js';
+export interface FunctionServicesMeta {
+    optimized: boolean;
+    services: string[];
+}
+export type FunctionsMeta = Record<string, {
+    pikkuFuncName: string;
+    name?: string;
+    services: FunctionServicesMeta;
+    schemaName: string | null;
+    inputs: string[] | null;
+    outputs: string[] | null;
+}>;
 export type MakeRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 /**
  * Represents a JSON primitive type which can be a string, number, boolean, null, or undefined.
@@ -81,6 +94,7 @@ export type PikkuMiddleware<SingletonServices extends CoreSingletonServices = Co
  */
 export type CoreServices<SingletonServices = CoreSingletonServices, UserSession extends CoreUserSession = CoreUserSession, CoreServices extends Record<string, unknown> = {}> = SingletonServices & PikkuInteraction & {
     userSession?: UserSessionService<UserSession>;
+    channel?: PikkuChannel<unknown, unknown>;
 } & CoreServices;
 export type SessionServices<SingletonServices extends CoreSingletonServices = CoreSingletonServices, Services = CoreServices<SingletonServices>> = Omit<Services, keyof SingletonServices | keyof PikkuInteraction | 'session'>;
 /**

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

@@ -8,9 +8,11 @@ import type { CoreServices, CoreSingletonServices, CoreUserSession } from './cor
  * @template Services - The services type, defaults to `CoreServices`.
  * @template Session - The session type, defaults to `CoreUserSession`.
  */
-export type CoreAPIFunction<In, Out, Services extends CoreSingletonServices = CoreServices & {
-    channel?: PikkuChannel<unknown, Out>;
-}, Session extends CoreUserSession = CoreUserSession, Channel extends boolean = false> = (services: Services, data: In, session: Session) => Channel extends true ? Promise<Out> | Promise<void> : Promise<Out>;
+export type CoreAPIFunction<In, Out, Channel extends boolean = false, Services extends CoreSingletonServices = CoreServices & (Channel extends true ? {
+    channel: PikkuChannel<unknown, Out>;
+} : {
+    channel?: PikkuChannel<unknown, Out> | undefined;
+}), Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session: Session) => Channel extends true ? Promise<Out> | Promise<void> : Promise<Out>;
 /**
  * Represents a core API function that can be used without a session.
  *
@@ -19,9 +21,11 @@ export type CoreAPIFunction<In, Out, Services extends CoreSingletonServices = Co
  * @template Services - The services type, defaults to `CoreServices`.
  * @template Session - The session type, defaults to `CoreUserSession`.
  */
-export type CoreAPIFunctionSessionless<In, Out, Services extends CoreSingletonServices = CoreServices & {
-    channel?: PikkuChannel<unknown, Out>;
-}, Session extends CoreUserSession = CoreUserSession, Channel extends boolean = false> = (services: Services, data: In, session?: Session) => Channel extends true ? Promise<Out> | Promise<void> : Promise<Out>;
+export type CoreAPIFunctionSessionless<In, Out, Channel extends boolean = false, Services extends CoreSingletonServices = CoreServices & (Channel extends true ? {
+    channel: PikkuChannel<unknown, Out>;
+} : {
+    channel?: PikkuChannel<unknown, Out> | undefined;
+}), Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session?: Session) => Channel extends true ? Promise<Out> | Promise<void> : Promise<Out>;
 /**
  * Represents a function that checks permissions for a given API operation.
  *
@@ -30,3 +34,4 @@ export type CoreAPIFunctionSessionless<In, Out, Services extends CoreSingletonSe
  * @template Session - The session type, defaults to `CoreUserSession`.
  */
 export type CoreAPIPermission<In = any, Services extends CoreSingletonServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session?: Session) => Promise<boolean>;
+export type CorePermissionGroup<APIPermission = CoreAPIPermission<any>> = Record<string, APIPermission | APIPermission[]> | undefined;

package/dist/utils.d.ts

@@ -1,2 +1,4 @@
 import { Logger } from './services/logger.js';
 export declare const closeSessionServices: (logger: Logger, sessionServices: Record<string, any>) => Promise<void>;
+export declare const createWeakUID: () => string;
+export declare const isSerializable: (data: any) => boolean;

package/dist/utils.js

@@ -13,3 +13,18 @@ export const closeSessionServices = async (logger, sessionServices) => {
         }
     }));
 };
+export const createWeakUID = () => {
+    return Date.now().toString(36) + Math.random().toString(36).substring(2, 10);
+};
+export const isSerializable = (data) => {
+    return !(typeof data === 'string' ||
+        data instanceof ArrayBuffer ||
+        data instanceof Uint8Array ||
+        data instanceof Int8Array ||
+        data instanceof Uint16Array ||
+        data instanceof Int16Array ||
+        data instanceof Uint32Array ||
+        data instanceof Int32Array ||
+        data instanceof Float32Array ||
+        data instanceof Float64Array);
+};

package/package.json

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