@pikku/cli 0.9.16-next.0 → 0.10.1

package/dist/.pikku/function/pikku-function-types.gen.js

@@ -1,39 +1,59 @@
 /**
- * This file was generated by the @pikku/cli
+ * This file was generated by @pikku/cli@0.10.1
  */
 /**
- * This file was generated by the @pikku/cli
  * Core function, middleware, and permission types for all wirings
  */
 import { addMiddleware as addMiddlewareCore, addPermission as addPermissionCore } from '@pikku/core';
 /**
  * Factory function for creating permissions with tree-shaking support.
- * This enables the bundler to detect which services your permission actually uses.
+ * Supports both direct function and configuration object syntax.
  *
  * @example
  * ```typescript
+ * // Direct function syntax
  * const permission = pikkuPermission(({ logger }, data, session) => {
- *   return session?.isAdmin || false
+ *   return session?.role === 'admin'
+ * })
+ *
+ * // Configuration object syntax with metadata
+ * const adminPermission = pikkuPermission({
+ *   name: 'Admin Permission',
+ *   description: 'Checks if user has admin role',
+ *   func: async ({ logger }, data, session) => {
+ *     return session?.role === 'admin'
+ *   }
  * })
  * ```
  */
-export const pikkuPermission = (func) => {
-    return func;
+export const pikkuPermission = (permission) => {
+    return typeof permission === 'function' ? permission : permission.func;
 };
 /**
  * Factory function for creating middleware with tree-shaking support.
- * This enables the bundler to detect which services your middleware actually uses.
+ * Supports both direct function and configuration object syntax.
  *
  * @example
  * ```typescript
+ * // Direct function syntax
  * const middleware = pikkuMiddleware(({ logger }, interactions, next) => {
  *   logger.info('Middleware executed')
  *   await next()
  * })
+ *
+ * // Configuration object syntax with metadata
+ * const logMiddleware = pikkuMiddleware({
+ *   name: 'Request Logger',
+ *   description: 'Logs all incoming requests',
+ *   func: async ({ logger }, interactions, next) => {
+ *     logger.info('Request started')
+ *     await next()
+ *   }
+ * })
  * ```
  */
-export const pikkuMiddleware = (func) => {
-    return func;
+export const pikkuMiddleware = (middleware) => {
+    return typeof middleware === 'function' ? middleware : middleware.func;
 };
 /**
  * Factory function for creating middleware factories
@@ -55,6 +75,28 @@ export const pikkuMiddleware = (func) => {
 export const pikkuMiddlewareFactory = (factory) => {
     return factory;
 };
+/**
+ * Factory function for creating permission factories
+ * Use this when your permission needs configuration/input parameters
+ *
+ * @example
+ * ```typescript
+ * export const requireRole = pikkuPermissionFactory<{ role: string }>(({
+ *   role
+ * }) => {
+ *   return pikkuPermission(async ({ logger }, data, session) => {
+ *     if (!session || session.role !== role) {
+ *       logger.warn(`Permission denied: required role '${role}'`)
+ *       return false
+ *     }
+ *     return true
+ *   })
+ * })
+ * ```
+ */
+export const pikkuPermissionFactory = (factory) => {
+    return factory;
+};
 /**
  * Creates a Pikku function that can be either session-aware or sessionless.
  * This is the main function wrapper for creating API endpoints.
@@ -121,6 +163,60 @@ export const pikkuSessionlessFunc = (func) => {
 export const pikkuVoidFunc = (func) => {
     return typeof func === 'function' ? { func } : func;
 };
+/**
+ * Creates a Pikku config factory.
+ * Use this to define your application's configuration factory.
+ *
+ * @param func - Config factory function that returns your application's config
+ * @returns The config factory function
+ *
+ * @example
+ * ```typescript
+ * export const createConfig = pikkuConfig(async () => {
+ *   return {
+ *     apiUrl: process.env.API_URL || 'http://localhost:3000',
+ *     dbUrl: process.env.DATABASE_URL
+ *   }
+ * })
+ * ```
+ */
+export const pikkuConfig = (func) => func;
+/**
+ * Creates a Pikku singleton services factory.
+ * Use this to define services that are created once and shared across all requests.
+ *
+ * @param func - Singleton services factory function
+ * @returns The singleton services factory function
+ *
+ * @example
+ * ```typescript
+ * export const createSingletonServices = pikkuServices(async (config, existingServices) => {
+ *   return {
+ *     config,
+ *     logger: new CustomLogger(),
+ *     db: await createDatabaseConnection(config.dbUrl)
+ *   }
+ * })
+ * ```
+ */
+export const pikkuServices = (func) => func;
+/**
+ * Creates a Pikku session services factory.
+ * Use this to define services that are created per-request/session.
+ *
+ * @param func - Session services factory function
+ * @returns The session services factory function
+ *
+ * @example
+ * ```typescript
+ * export const createSessionServices = pikkuSessionServices(async (services, interaction, session) => {
+ *   return {
+ *     userCache: new UserCache(session?.userId)
+ *   }
+ * })
+ * ```
+ */
+export const pikkuSessionServices = (func) => func;
 /**
  * Adds global middleware for a specific tag.
  *
@@ -154,7 +250,7 @@ export const addMiddleware = (tag, middleware) => {
  * any wiring (HTTP, Channel, Queue, Scheduler, MCP) that includes the matching tag.
  *
  * @param tag - The tag that the permissions should apply to.
- * @param permissions - The permissions array to apply for the specified tag.
+ * @param permissions - The permissions array or object to apply for the specified tag.
  *
  * @throws Error if permissions for the tag already exist.
  *
@@ -166,8 +262,8 @@ export const addMiddleware = (tag, middleware) => {
  * // Add authentication permissions for auth endpoints
  * addPermission('auth', [authPermission])
  *
- * // Add read permissions for all API endpoints
- * addPermission('api', [readPermission])
+ * // Add read permissions for all API endpoints (as object)
+ * addPermission('api', { read: readPermission })
  * ```
  */
 export const addPermission = (tag, permissions) => {