@pikku/addon-console 0.12.2 → 0.12.3

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

@@ -0,0 +1,314 @@
+/**
+ * This file was generated by @pikku/cli@0.12.3
+ */
+/**
+ * Core function, middleware, and permission types for all wirings
+ */
+import { addMiddleware as addMiddlewareCore, addPermission as addPermissionCore } from '@pikku/core';
+import { pikkuState as __pikkuState } from '@pikku/core/internal';
+import { pikkuAuth as pikkuAuthCore } from '@pikku/core';
+/**
+ * Factory function for creating permissions with tree-shaking support.
+ * Supports both direct function and configuration object syntax.
+ *
+ * @example
+ * ```typescript
+ * // Direct function syntax
+ * const permission = pikkuPermission(async ({ logger }, data, { session }) => {
+ *   const session = await session?.get()
+ *   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 }) => {
+ *     const session = await session?.get()
+ *     return session?.role === 'admin'
+ *   }
+ * })
+ * ```
+ */
+export const pikkuPermission = (permission) => {
+    return typeof permission === 'function' ? permission : permission.func;
+};
+/**
+ * Factory function for creating auth-only permissions with tree-shaking support.
+ * Auth permissions only receive services and session (no request data),
+ * making them evaluable before request data is available.
+ *
+ * @example
+ * \`\`\`typescript
+ * const isAuthenticated = pikkuAuth(async ({ logger }, session) => {
+ *   return !!session
+ * })
+ *
+ * const isAdmin = pikkuAuth({
+ *   name: 'Admin Auth',
+ *   description: 'Checks if user is an admin',
+ *   func: async ({ logger }, session) => {
+ *     return session?.role === 'admin'
+ *   }
+ * })
+ * \`\`\`
+ */
+export const pikkuAuth = (auth) => {
+    return pikkuAuthCore(auth);
+};
+/**
+ * Factory function for creating middleware with tree-shaking support.
+ * Supports both direct function and configuration object syntax.
+ *
+ * @example
+ * ```typescript
+ * // Direct function syntax
+ * const middleware = pikkuMiddleware(({ logger }, wires, 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 }, wires, next) => {
+ *     logger.info('Request started')
+ *     await next()
+ *   }
+ * })
+ * ```
+ */
+export const pikkuMiddleware = (middleware) => {
+    return typeof middleware === 'function' ? middleware : middleware.func;
+};
+/**
+ * Factory function for creating middleware factories
+ * Use this when your middleware needs configuration/input parameters
+ *
+ * @example
+ * ```typescript
+ * export const logMiddleware = pikkuMiddlewareFactory<LogOptions>(({
+ *   message,
+ *   level = 'info'
+ * }) => {
+ *   return pikkuMiddleware(async ({ logger }, next) => {
+ *     logger[level](message)
+ *     await next()
+ *   })
+ * })
+ * ```
+ */
+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;
+};
+/**
+ * Factory function for creating approval description functions with tree-shaking support.
+ *
+ * @example
+ * ```typescript
+ * export const deleteTodoApproval = pikkuApprovalDescription(
+ *   async ({ todoStore }, { id }) => {
+ *     const todo = await todoStore.get(id)
+ *     return \`Delete todo: "${todo.title}"\`
+ *   }
+ * )
+ * ```
+ */
+export const pikkuApprovalDescription = (fn) => {
+    return fn;
+};
+export function pikkuFunc(func) {
+    return typeof func === 'function' ? { func } : func;
+}
+export function pikkuSessionlessFunc(func) {
+    return typeof func === 'function' ? { func } : func;
+}
+/**
+ * Creates a function that takes no input and returns no output.
+ * Useful for health checks, triggers, or cleanup operations.
+ *
+ * @param func - Function definition, either direct function or configuration object
+ * @returns The normalized configuration object
+ *
+ * @example
+ * ```typescript
+ * const cleanupTempFiles = pikkuVoidFunc(async ({fileSystem, logger}) => {
+ *     logger.info('Starting cleanup of temporary files')
+ *     await fileSystem.deleteDirectory('/tmp/uploads')
+ *     logger.info('Cleanup completed')
+ * })
+ * ```
+ */
+export const pikkuVoidFunc = (func) => {
+    return typeof func === 'function' ? { func } : func;
+};
+/**
+ * Creates a wrapper function for addon package functions that are exposed via RPC.
+ * This allows you to wire addon functions to any wiring type (HTTP, queue, etc.)
+ * without type compatibility issues.
+ *
+ * @template Name - The RPC method name (must be a key in FlattenedRPCMap)
+ * @param rpcName - The name of the RPC method to invoke
+ * @returns A Pikku function that proxies calls to the addon RPC method
+ *
+ * @example
+ * ```typescript
+ * // Wire an addon function via HTTP
+ * wireHTTP({
+ *   auth: false,
+ *   method: 'get',
+ *   route: '/addon/hello',
+ *   func: addon('ext:hello'),
+ *   tags: ['addon'],
+ * })
+ * ```
+ */
+export const addon = (rpcName) => {
+    return {
+        func: async (_services, data, { rpc }) => {
+            return rpc.invoke(rpcName, data);
+        }
+    };
+};
+/**
+ * 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) => {
+    return async (config, existingServices = {}) => {
+        const services = await func(config, existingServices);
+        __pikkuState(null, 'package', 'singletonServices', services);
+        return services;
+    };
+};
+/**
+ * Creates a Pikku wire services factory.
+ * Use this to define services that are created per-request/session.
+ *
+ * @param func - Wire services factory function
+ * @returns The wire services factory function
+ *
+ * @example
+ * ```typescript
+ * export const createWireServices = pikkuWireServices(async (services, wire) => {
+ *   const session = await wire.session?.get()
+ *   return {
+ *     userCache: new UserCache(session?.userId)
+ *   }
+ * })
+ * ```
+ */
+export const pikkuWireServices = (func) => {
+    const factories = __pikkuState(null, 'package', 'factories');
+    __pikkuState(null, 'package', 'factories', { ...factories, createWireServices: func });
+    return func;
+};
+/**
+ * Adds global middleware for a specific tag.
+ *
+ * This function allows you to register middleware that will be applied to
+ * any wiring (HTTP, Channel, Queue, Scheduler, MCP) that includes the matching tag.
+ *
+ * @param tag - The tag that the middleware should apply to.
+ * @param middleware - The middleware array to apply for the specified tag.
+ *
+ * @throws Error if middleware for the tag already exists.
+ *
+ * @example
+ * ```typescript
+ * // Add admin middleware for admin endpoints
+ * addMiddleware('admin', [adminMiddleware])
+ *
+ * // Add authentication middleware for auth endpoints
+ * addMiddleware('auth', [authMiddleware])
+ *
+ * // Add logging middleware for all API endpoints
+ * addMiddleware('api', [loggingMiddleware])
+ * ```
+ */
+export const addMiddleware = (tag, middleware) => {
+    addMiddlewareCore(tag, middleware, '@pikku/addon-console');
+};
+/**
+ * Adds global permissions for a specific tag.
+ *
+ * This function allows you to register permissions that will be applied to
+ * 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 or object to apply for the specified tag.
+ *
+ * @throws Error if permissions for the tag already exist.
+ *
+ * @example
+ * ```typescript
+ * // Add admin permissions for admin endpoints
+ * addPermission('admin', [adminPermission])
+ *
+ * // Add authentication permissions for auth endpoints
+ * addPermission('auth', [authPermission])
+ *
+ * // Add read permissions for all API endpoints (as object)
+ * addPermission('api', { read: readPermission })
+ * ```
+ */
+export const addPermission = (tag, permissions) => {
+    addPermissionCore(tag, permissions, '@pikku/addon-console');
+};
+export { wireAddon } from '@pikku/core';
+//# sourceMappingURL=pikku-function-types.gen.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pikku-function-types.gen.js","sourceRoot":"","sources":["../../../.pikku/function/pikku-function-types.gen.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;GAEG;AAEH,OAAO,EAA8H,aAAa,IAAI,iBAAiB,EAAE,aAAa,IAAI,iBAAiB,EAA2B,MAAM,aAAa,CAAA;AACzP,OAAO,EAAE,UAAU,IAAI,YAAY,EAAsB,MAAM,sBAAsB,CAAA;AACrF,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,aAAa,CAAA;AA0DxD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,UAA2D,EACtC,EAAE;IACvB,OAAO,OAAO,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAA;AACxE,CAAC,CAAA;AAgBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,IAAqE,EAC1C,EAAE;IAC7B,OAAO,aAAa,CAAC,IAAW,CAAQ,CAAA;AAC1C,CAAC,CAAA;AAcD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,UAAuF,EACpD,EAAE;IACrC,OAAO,OAAO,UAAU,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAA;AACxE,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAuC,EACL,EAAE;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAA4C,EACL,EAAE;IACzC,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAcD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,EAAkD,EACF,EAAE;IAClD,OAAO,EAAE,CAAA;AACX,CAAC,CAAA;AAsJD,MAAM,UAAU,SAAS,CAAC,IAAS;IACjC,OAAO,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACrD,CAAC;AA+ED,MAAM,UAAU,oBAAoB,CAAC,IAAS;IAC5C,OAAO,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACrD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,IAEsD,EACtD,EAAE;IACF,OAAO,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACrD,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CACnB,OAAa,EAKb,EAAE;IACF,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,SAAc,EAAE,IAAoC,EAAE,EAAE,GAAG,EAAO,EAAE,EAAE;YACjF,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KAKF,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAA0D,EAC1D,EAAE,CAAC,IAAI,CAAA;AAGT;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,IAA0G,EAC1G,EAAE;IACF,OAAO,KAAK,EAAE,MAAc,EAAE,mBAA+C,EAAE,EAAE,EAAE;QACjF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;QACrD,YAAY,CAAC,IAAI,EAAE,SAAS,EAAE,mBAAmB,EAAE,QAAe,CAAC,CAAA;QACnE,OAAO,QAAQ,CAAA;IACjB,CAAC,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,IAGkC,EACd,EAAE;IACtB,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAA;IAC5D,YAAY,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,GAAG,SAAS,EAAE,kBAAkB,EAAE,IAAW,EAAE,CAAC,CAAA;IAC7F,OAAO,IAAqC,CAAA;AAC9C,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,UAA6B,EAAE,EAAE;IAC1E,iBAAiB,CAAC,GAAG,EAAE,UAAiB,EAAE,sBAAsB,CAAC,CAAA;AACnE,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAe,GAAW,EAAE,WAA6E,EAAE,EAAE;IACxI,iBAAiB,CAAC,GAAG,EAAE,WAAkB,EAAE,sBAAsB,CAAC,CAAA;AACpE,CAAC,CAAA;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA"}

package/dist/.pikku/function/pikku-functions-meta.gen.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pikku-functions-meta.gen.d.ts.map

package/dist/.pikku/function/pikku-functions-meta.gen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pikku-functions-meta.gen.d.ts","sourceRoot":"","sources":["../../../.pikku/function/pikku-functions-meta.gen.ts"],"names":[],"mappings":""}

package/dist/.pikku/function/pikku-functions-meta.gen.js

@@ -0,0 +1,7 @@
+/**
+ * This file was generated by @pikku/cli@0.12.3
+ */
+import { pikkuState } from '@pikku/core/internal';
+import metaData from './pikku-functions-meta.gen.json' with { type: 'json' };
+pikkuState('@pikku/addon-console', 'function', 'meta', metaData);
+//# sourceMappingURL=pikku-functions-meta.gen.js.map

package/dist/.pikku/function/pikku-functions-meta.gen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pikku-functions-meta.gen.js","sourceRoot":"","sources":["../../../.pikku/function/pikku-functions-meta.gen.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,QAAQ,MAAM,iCAAiC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAA;AAC5E,UAAU,CAAC,sBAAsB,EAAE,UAAU,EAAE,MAAM,EAAE,QAAyB,CAAC,CAAA"}