@pikku/core 0.9.11 → 0.10.0

package/dist/permissions.d.ts

@@ -1,4 +1,4 @@
-import { CoreServices, CoreUserSession, PikkuWiringTypes } from './types/core.types.js';
+import { CoreServices, CoreUserSession, PikkuWiringTypes, PermissionMetadata } from './types/core.types.js';
 import { CorePermissionGroup, CorePikkuPermission } from './function/functions.types.js';
 /**
  * This function validates permissions by iterating over permission groups and executing the corresponding permission functions. If all functions in at least one group return true, the permission is considered valid.
@@ -8,30 +8,65 @@ import { CorePermissionGroup, CorePikkuPermission } from './function/functions.t
  * @returns A promise that resolves to void.
  */
 export declare const verifyPermissions: (permissions: CorePermissionGroup, services: CoreServices, data: any, session?: CoreUserSession) => Promise<boolean>;
+/**
+ * Registers a single permission function by name in the global permission store.
+ *
+ * This function is used by CLI-generated code to register permission functions
+ * that can be referenced by name in metadata. It stores permissions in a special
+ * namespace to avoid conflicts with tag-based permissions.
+ *
+ * @param {string} name - The unique name (pikkuFuncName) of the permission function.
+ * @param {CorePikkuPermission} permission - The permission function to register.
+ *
+ * @example
+ * ```typescript
+ * // Called by CLI-generated pikku-permissions.gen.ts
+ * registerPermission('adminPermission_src_permissions_ts_10_5', adminPermission)
+ * registerPermission('readPermission_src_permissions_ts_20_10', readPermission)
+ * ```
+ */
+export declare const registerPermission: (name: string, permission: CorePikkuPermission<any>) => void;
+/**
+ * Retrieves a registered permission function by its name.
+ *
+ * This function looks up permissions that was registered with registerPermission.
+ * It's used internally by the framework to resolve permission references in metadata.
+ *
+ * @param {string} name - The unique name (pikkuFuncName) of the permission function.
+ * @returns {CorePikkuPermission | undefined} The permission function, or undefined if not found.
+ *
+ * @internal
+ */
+export declare const getPermissionByName: (name: string) => CorePikkuPermission | undefined;
 /**
  * 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.
  *
+ * For tree-shaking benefits, wrap in a factory function:
+ * `export const x = () => addPermission('tag', [...])`
+ *
  * @param {string} tag - The tag that the permissions should apply to.
  * @param {any[]} permissions - The permissions array to apply for the specified tag.
  *
- * @throws {Error} If permissions for the tag already exist.
+ * @returns {CorePermissionGroup | CorePikkuPermission[]} The permissions (for chaining/wrapping).
  *
  * @example
  * ```typescript
- * // Add admin permissions for admin endpoints
- * addPermission('admin', [adminPermission])
- *
- * // Add authentication permissions for auth endpoints
- * addPermission('auth', [authPermission])
+ * // Recommended: tree-shakeable
+ * export const adminPermissions = () => addPermission('admin', [
+ *   adminPermission,
+ *   rolePermission({ role: 'admin' })
+ * ])
  *
- * // Add read permissions for all API endpoints
- * addPermission('api', [readPermission])
+ * // Also works: no tree-shaking
+ * export const apiPermissions = addPermission('api', [
+ *   readPermission
+ * ])
  * ```
  */
-export declare const addPermission: (tag: string, permissions: CorePermissionGroup | CorePikkuPermission[]) => void;
+export declare const addPermission: (tag: string, permissions: CorePermissionGroup | CorePikkuPermission[]) => CorePermissionGroup | CorePikkuPermission[];
 /**
  * Retrieves permissions for a given set of tags.
  *
@@ -49,17 +84,44 @@ export declare const addPermission: (tag: string, permissions: CorePermissionGro
  */
 export declare const getPermissionsForTags: (tags?: string[]) => readonly (CorePermissionGroup | CorePikkuPermission)[];
 /**
- * Runs permission checks in the specified order:
- * 1) wiring tag permissions - at least one must pass if any exist
- * 2) wiring permissions - must pass if defined
- * 3) function tag permissions - at least one must pass if any exist
- * 4) function permissions - must pass if defined
+ * Combines wiring-specific permissions with function-level permissions.
+ *
+ * This function resolves permission metadata into actual permission functions and combines them.
+ * It filters out wire permissions without tags from inheritedPermissions to avoid duplication
+ * (those are passed separately as wirePermissions).
+ *
+ * @param {object} options - Configuration object for combining permissions.
+ * @param {PermissionMetadata[] | undefined} options.wireInheritedPermissions - Metadata from wiring (HTTP + tags + wire with tags).
+ * @param {CorePermissionGroup | CorePikkuPermission[] | undefined} options.wirePermissions - Inline wire permissions.
+ * @param {PermissionMetadata[] | undefined} options.funcInheritedPermissions - Function permissions metadata (only tags).
+ * @param {CorePermissionGroup | CorePikkuPermission[] | undefined} options.funcPermissions - Inline function permissions.
+ * @returns {(CorePermissionGroup | CorePikkuPermission)[]} Combined array of resolved permissions.
+ *
+ * @example
+ * ```typescript
+ * const combined = combinePermissions(wireType, wireId, {
+ *   wireInheritedPermissions: meta.permissions,
+ *   wirePermissions: inlinePermissions,
+ *   funcInheritedPermissions: funcMeta.permissions,
+ *   funcPermissions: funcConfig.permissions
+ * })
+ * ```
+ */
+export declare const combinePermissions: (wireType: PikkuWiringTypes, uid: string, { wireInheritedPermissions, wirePermissions, funcInheritedPermissions, funcPermissions, }?: {
+    wireInheritedPermissions?: PermissionMetadata[];
+    wirePermissions?: CorePermissionGroup | CorePikkuPermission[];
+    funcInheritedPermissions?: PermissionMetadata[];
+    funcPermissions?: CorePermissionGroup | CorePikkuPermission[];
+}) => readonly (CorePermissionGroup | CorePikkuPermission)[];
+/**
+ * Runs permission checks using combined permissions from all sources.
+ * Combines permissions from wire and function levels, then validates them.
  */
-export declare const runPermissions: (wireType: PikkuWiringTypes, uid: string, { wiringTags, wiringPermissions, funcTags, funcPermissions, allServices, data, session, }: {
-    wiringTags?: string[];
-    wiringPermissions?: CorePermissionGroup;
-    funcTags?: string[];
-    funcPermissions?: CorePermissionGroup;
+export declare const runPermissions: (wireType: PikkuWiringTypes, uid: string, { wireInheritedPermissions, wirePermissions, funcInheritedPermissions, funcPermissions, allServices, data, session, }: {
+    wireInheritedPermissions?: PermissionMetadata[];
+    wirePermissions?: CorePermissionGroup | CorePikkuPermission[];
+    funcInheritedPermissions?: PermissionMetadata[];
+    funcPermissions?: CorePermissionGroup | CorePikkuPermission[];
     allServices: CoreServices;
     data: any;
     session?: CoreUserSession;

package/dist/permissions.js

@@ -1,6 +1,7 @@
 import { PikkuWiringTypes, } from './types/core.types.js';
 import { pikkuState } from './pikku-state.js';
 import { ForbiddenError } from './errors/errors.js';
+import { freezeDedupe } from './utils.js';
 /**
  * This function validates permissions by iterating over permission groups and executing the corresponding permission functions. If all functions in at least one group return true, the permission is considered valid.
  * @param services - The core services required for permission validation.
@@ -33,36 +34,81 @@ export const verifyPermissions = async (permissions, services, data, session) =>
     }
     return false;
 };
+/**
+ * Registers a single permission function by name in the global permission store.
+ *
+ * This function is used by CLI-generated code to register permission functions
+ * that can be referenced by name in metadata. It stores permissions in a special
+ * namespace to avoid conflicts with tag-based permissions.
+ *
+ * @param {string} name - The unique name (pikkuFuncName) of the permission function.
+ * @param {CorePikkuPermission} permission - The permission function to register.
+ *
+ * @example
+ * ```typescript
+ * // Called by CLI-generated pikku-permissions.gen.ts
+ * registerPermission('adminPermission_src_permissions_ts_10_5', adminPermission)
+ * registerPermission('readPermission_src_permissions_ts_20_10', readPermission)
+ * ```
+ */
+export const registerPermission = (name, permission) => {
+    const permissionStore = pikkuState('misc', 'permissions');
+    permissionStore[name] = [permission];
+};
+/**
+ * Retrieves a registered permission function by its name.
+ *
+ * This function looks up permissions that was registered with registerPermission.
+ * It's used internally by the framework to resolve permission references in metadata.
+ *
+ * @param {string} name - The unique name (pikkuFuncName) of the permission function.
+ * @returns {CorePikkuPermission | undefined} The permission function, or undefined if not found.
+ *
+ * @internal
+ */
+export const getPermissionByName = (name) => {
+    const permissionStore = pikkuState('misc', 'permissions');
+    const permission = permissionStore[name];
+    if (Array.isArray(permission) && permission.length === 1) {
+        return permission[0];
+    }
+    return undefined;
+};
 /**
  * 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.
  *
+ * For tree-shaking benefits, wrap in a factory function:
+ * `export const x = () => addPermission('tag', [...])`
+ *
  * @param {string} tag - The tag that the permissions should apply to.
  * @param {any[]} permissions - The permissions array to apply for the specified tag.
  *
- * @throws {Error} If permissions for the tag already exist.
+ * @returns {CorePermissionGroup | CorePikkuPermission[]} The permissions (for chaining/wrapping).
  *
  * @example
  * ```typescript
- * // Add admin permissions for admin endpoints
- * addPermission('admin', [adminPermission])
- *
- * // Add authentication permissions for auth endpoints
- * addPermission('auth', [authPermission])
+ * // Recommended: tree-shakeable
+ * export const adminPermissions = () => addPermission('admin', [
+ *   adminPermission,
+ *   rolePermission({ role: 'admin' })
+ * ])
  *
- * // Add read permissions for all API endpoints
- * addPermission('api', [readPermission])
+ * // Also works: no tree-shaking
+ * export const apiPermissions = addPermission('api', [
+ *   readPermission
+ * ])
  * ```
  */
 export const addPermission = (tag, permissions) => {
-    const permissionsStore = pikkuState('misc', 'permissions');
-    // Check if tag already exists
-    if (permissionsStore[tag]) {
+    const tagGroups = pikkuState('permissions', 'tagGroup');
+    if (tagGroups[tag]) {
         throw new Error(`Permissions for tag '${tag}' already exist. Use a different tag or remove the existing permissions first.`);
     }
-    permissionsStore[tag] = permissions;
+    tagGroups[tag] = permissions;
+    return permissions;
 };
 const EMPTY = [];
 /**
@@ -84,7 +130,7 @@ export const getPermissionsForTags = (tags) => {
     if (!tags || tags.length === 0) {
         return EMPTY;
     }
-    const permissionsStore = pikkuState('misc', 'permissions');
+    const permissionsStore = pikkuState('permissions', 'tagGroup');
     const applicablePermissions = [];
     // Collect permissions for all matching tags
     for (const tag of new Set(tags)) {
@@ -100,76 +146,144 @@ export const getPermissionsForTags = (tags) => {
     }
     return applicablePermissions;
 };
-const permissionCache = {
+const combinedPermissionsCache = {
     [PikkuWiringTypes.http]: {},
     [PikkuWiringTypes.rpc]: {},
     [PikkuWiringTypes.channel]: {},
     [PikkuWiringTypes.queue]: {},
     [PikkuWiringTypes.scheduler]: {},
     [PikkuWiringTypes.mcp]: {},
+    [PikkuWiringTypes.cli]: {},
 };
 /**
- * Runs permission checks in the specified order:
- * 1) wiring tag permissions - at least one must pass if any exist
- * 2) wiring permissions - must pass if defined
- * 3) function tag permissions - at least one must pass if any exist
- * 4) function permissions - must pass if defined
+ * Combines wiring-specific permissions with function-level permissions.
+ *
+ * This function resolves permission metadata into actual permission functions and combines them.
+ * It filters out wire permissions without tags from inheritedPermissions to avoid duplication
+ * (those are passed separately as wirePermissions).
+ *
+ * @param {object} options - Configuration object for combining permissions.
+ * @param {PermissionMetadata[] | undefined} options.wireInheritedPermissions - Metadata from wiring (HTTP + tags + wire with tags).
+ * @param {CorePermissionGroup | CorePikkuPermission[] | undefined} options.wirePermissions - Inline wire permissions.
+ * @param {PermissionMetadata[] | undefined} options.funcInheritedPermissions - Function permissions metadata (only tags).
+ * @param {CorePermissionGroup | CorePikkuPermission[] | undefined} options.funcPermissions - Inline function permissions.
+ * @returns {(CorePermissionGroup | CorePikkuPermission)[]} Combined array of resolved permissions.
+ *
+ * @example
+ * ```typescript
+ * const combined = combinePermissions(wireType, wireId, {
+ *   wireInheritedPermissions: meta.permissions,
+ *   wirePermissions: inlinePermissions,
+ *   funcInheritedPermissions: funcMeta.permissions,
+ *   funcPermissions: funcConfig.permissions
+ * })
+ * ```
  */
-export const runPermissions = async (wireType, uid, { wiringTags, wiringPermissions, funcTags, funcPermissions, allServices, data, session, }) => {
-    let cachedPermission = permissionCache[wireType][uid];
-    if (!cachedPermission) {
-        cachedPermission = {
-            wiringTags: getPermissionsForTags(wiringTags),
-            funcTags: getPermissionsForTags(funcTags),
-        };
-        permissionCache[wireType][uid] = cachedPermission;
+export const combinePermissions = (wireType, uid, { wireInheritedPermissions, wirePermissions, funcInheritedPermissions, funcPermissions, } = {}) => {
+    if (combinedPermissionsCache[wireType][uid]) {
+        return combinedPermissionsCache[wireType][uid];
     }
-    let permissioned = true;
-    // 1. Wiring tag permissions - at least one must pass if any exist
-    const wiringTaggedPermissions = cachedPermission.wiringTags;
-    if (wiringTaggedPermissions.length > 0) {
-        permissioned = false; // Start false, need at least one to pass
-        for (const permissions of wiringTaggedPermissions) {
-            const result = await verifyPermissions(typeof permissions === 'function' ? { permissions } : permissions, allServices, data, session);
-            if (result) {
-                permissioned = true;
-                break; // At least one passed, we're good at this level
+    const resolved = [];
+    // 1. Resolve wire inherited permissions (HTTP + tag groups + individual wire permissions)
+    if (wireInheritedPermissions) {
+        for (const meta of wireInheritedPermissions) {
+            if (meta.type === 'http') {
+                // Look up HTTP permission group from pikkuState
+                const group = pikkuState('permissions', 'httpGroup')[meta.route];
+                if (group) {
+                    if (Array.isArray(group)) {
+                        resolved.push(...group);
+                    }
+                    else {
+                        resolved.push(group);
+                    }
+                }
+            }
+            else if (meta.type === 'tag') {
+                // Look up tag permission group from pikkuState
+                const group = pikkuState('permissions', 'tagGroup')[meta.tag];
+                if (group) {
+                    if (Array.isArray(group)) {
+                        resolved.push(...group);
+                    }
+                    else {
+                        resolved.push(group);
+                    }
+                }
+            }
+            else if (meta.type === 'wire') {
+                // Individual wire permission (exported, not inline)
+                const permission = getPermissionByName(meta.name);
+                if (permission) {
+                    resolved.push(permission);
+                }
             }
         }
-        if (!permissioned) {
-            allServices.logger.debug('Permission denied - wiring tag permissions');
-            throw new ForbiddenError('Permission denied');
+    }
+    // 2. Add inline wire permissions
+    if (wirePermissions) {
+        if (Array.isArray(wirePermissions)) {
+            resolved.push(...wirePermissions);
+        }
+        else {
+            resolved.push(wirePermissions);
         }
     }
-    // 2. Wiring permissions - must pass if defined
-    if (wiringPermissions) {
-        permissioned = await verifyPermissions(wiringPermissions, allServices, data, session);
-        if (!permissioned) {
-            allServices.logger.debug('Permission denied - wiring permissions');
-            throw new ForbiddenError('Permission denied');
+    // 3. Resolve function inherited permissions (only tags, wire permissions already handled)
+    if (funcInheritedPermissions) {
+        for (const meta of funcInheritedPermissions) {
+            if (meta.type === 'tag') {
+                // Look up tag permission group from pikkuState
+                const group = pikkuState('permissions', 'tagGroup')[meta.tag];
+                if (group) {
+                    if (Array.isArray(group)) {
+                        resolved.push(...group);
+                    }
+                    else {
+                        resolved.push(group);
+                    }
+                }
+            }
+            // Note: wire permissions are already handled in wireInheritedPermissions
+        }
+    }
+    // 4. Add inline function permissions
+    if (funcPermissions) {
+        if (Array.isArray(funcPermissions)) {
+            resolved.push(...funcPermissions);
+        }
+        else {
+            resolved.push(funcPermissions);
         }
     }
-    // 3. Function tag permissions - at least one must pass if any exist
-    const funcTaggedPermissions = cachedPermission.funcTags;
-    if (funcTaggedPermissions.length > 0) {
-        permissioned = false; // Start false, need at least one to pass
-        for (const permissions of funcTaggedPermissions) {
-            const result = await verifyPermissions(typeof permissions === 'function' ? { permissions } : permissions, allServices, data, session);
+    // Deduplicate and freeze
+    combinedPermissionsCache[wireType][uid] = freezeDedupe(resolved);
+    return combinedPermissionsCache[wireType][uid];
+};
+/**
+ * Runs permission checks using combined permissions from all sources.
+ * Combines permissions from wire and function levels, then validates them.
+ */
+export const runPermissions = async (wireType, uid, { wireInheritedPermissions, wirePermissions, funcInheritedPermissions, funcPermissions, allServices, data, session, }) => {
+    // Combine all permissions: wireInheritedPermissions → wirePermissions → funcInheritedPermissions → funcPermissions
+    const allPermissions = combinePermissions(wireType, uid, {
+        wireInheritedPermissions,
+        wirePermissions,
+        funcInheritedPermissions,
+        funcPermissions,
+    });
+    // Check all combined permissions - at least one must pass if any exist
+    if (allPermissions.length > 0) {
+        let permissioned = false;
+        for (const permission of allPermissions) {
+            const result = await verifyPermissions(typeof permission === 'function' ? { permission } : permission, allServices, data, session);
             if (result) {
                 permissioned = true;
-                break; // At least one passed, we're good at this level
+                // Continue executing all permissions (don't break early)
             }
         }
         if (!permissioned) {
-            allServices.logger.debug('Permission denied - function tag permissions');
-            throw new ForbiddenError('Permission denied');
-        }
-    }
-    // 4. Function permissions - must pass if defined
-    if (funcPermissions) {
-        permissioned = await verifyPermissions(funcPermissions, allServices, data, session);
-        if (!permissioned) {
-            allServices.logger.debug('Permission denied - function permissions');
+            allServices.logger.debug('Permission denied - combined permissions');
             throw new ForbiddenError('Permission denied');
         }
     }

package/dist/pikku-state.d.ts

@@ -1,11 +1,12 @@
 import { ChannelsMeta, CoreChannel } from './wirings/channel/channel.types.js';
 import { CoreHTTPFunctionWiring, HTTPMethod, HTTPWiringsMeta } from './wirings/http/http.types.js';
-import { FunctionsMeta, CorePikkuMiddleware } from './types/core.types.js';
+import { FunctionsMeta, CorePikkuMiddleware, CorePikkuMiddlewareGroup, FunctionServicesMeta } from './types/core.types.js';
 import { CoreScheduledTask, ScheduledTasksMeta } from './wirings/scheduler/scheduler.types.js';
 import { ErrorDetails, PikkuError } from './errors/error-handler.js';
 import { CorePermissionGroup, CorePikkuFunctionConfig, CorePikkuPermission } from './function/functions.types.js';
 import { queueWorkersMeta, CoreQueueWorker } from './wirings/queue/queue.types.js';
 import { CoreMCPResource, CoreMCPTool, CoreMCPPrompt, MCPResourceMeta, MCPToolMeta, MCPPromptMeta } from './wirings/mcp/mcp.types.js';
+import { CLIMeta, CLIProgramState } from './wirings/cli/cli.types.js';
 interface PikkuState {
     function: {
         meta: FunctionsMeta;
@@ -44,6 +45,50 @@ interface PikkuState {
         prompts: Map<string, CoreMCPPrompt>;
         promptsMeta: MCPPromptMeta;
     };
+    cli: {
+        meta: CLIMeta | Record<string, any>;
+        programs: Record<string, CLIProgramState>;
+    };
+    middleware: {
+        tagGroup: Record<string, CorePikkuMiddlewareGroup>;
+        httpGroup: Record<string, CorePikkuMiddlewareGroup>;
+        tagGroupMeta: Record<string, {
+            exportName: string | null;
+            sourceFile: string;
+            position: number;
+            services: FunctionServicesMeta;
+            middlewareCount: number;
+            isFactory: boolean;
+        }>;
+        httpGroupMeta: Record<string, {
+            exportName: string | null;
+            sourceFile: string;
+            position: number;
+            services: FunctionServicesMeta;
+            middlewareCount: number;
+            isFactory: boolean;
+        }>;
+    };
+    permissions: {
+        tagGroup: Record<string, CorePermissionGroup | CorePikkuPermission[]>;
+        httpGroup: Record<string, CorePermissionGroup | CorePikkuPermission[]>;
+        tagGroupMeta: Record<string, {
+            exportName: string | null;
+            sourceFile: string;
+            position: number;
+            services: FunctionServicesMeta;
+            permissionCount: number;
+            isFactory: boolean;
+        }>;
+        httpGroupMeta: Record<string, {
+            exportName: string | null;
+            sourceFile: string;
+            position: number;
+            services: FunctionServicesMeta;
+            permissionCount: number;
+            isFactory: boolean;
+        }>;
+    };
     misc: {
         errors: Map<PikkuError, ErrorDetails>;
         schemas: Map<string, any>;

package/dist/pikku-state.js

@@ -10,7 +10,6 @@ export const resetPikkuState = () => {
         },
         http: {
             permissions: new Map(),
-            middleware: new Map(),
             routes: new Map(),
             meta: {},
         },
@@ -34,6 +33,22 @@ export const resetPikkuState = () => {
             prompts: new Map(),
             promptsMeta: {},
         },
+        cli: {
+            meta: { programs: {}, renderers: {} },
+            programs: {},
+        },
+        middleware: {
+            tagGroup: {},
+            httpGroup: {},
+            tagGroupMeta: {},
+            httpGroupMeta: {},
+        },
+        permissions: {
+            tagGroup: {},
+            httpGroup: {},
+            tagGroupMeta: {},
+            httpGroupMeta: {},
+        },
         misc: {
             errors: globalThis.pikkuState?.misc?.errors || new Map(),
             schemas: new Map(),

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

@@ -1,4 +1,3 @@
-import { ReadStream } from 'fs';
 export interface ContentService {
     /**
      * Signs a content key to generate a secure, time-limited access URL.
@@ -36,7 +35,7 @@ export interface ContentService {
      * @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: ReadableStream | NodeJS.ReadableStream): Promise<boolean>;
     /**
      * Copies a file from a local absolute path into storage under a new asset key.
      * @param assetKey - The destination key.
@@ -49,5 +48,5 @@ export interface ContentService {
      * @param assetKey - The key of the file to read.
      * @returns A readable file stream.
      */
-    readFile(assetKey: string): Promise<ReadStream>;
+    readFile(assetKey: string): Promise<ReadableStream | NodeJS.ReadableStream>;
 }

package/dist/services/index.d.ts

@@ -11,4 +11,3 @@ export * from './user-session-service.js';
 export * from './local-secrets.js';
 export * from './local-variables.js';
 export * from './logger-console.js';
-export * from './local-content.js';

package/dist/services/index.js

@@ -13,4 +13,3 @@ export * from './user-session-service.js';
 export * from './local-secrets.js';
 export * from './local-variables.js';
 export * from './logger-console.js';
-export * from './local-content.js';

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

@@ -1,6 +1,4 @@
-import { ReadStream } from 'fs';
 import { ContentService, Logger } from '@pikku/core/services';
-import { Readable } from 'stream';
 export interface LocalContentConfig {
     localFileUploadPath: string;
     uploadUrlPrefix: string;
@@ -19,9 +17,9 @@ export declare class LocalContent implements ContentService {
         uploadUrl: string;
         assetKey: string;
     }>;
-    writeFile(assetKey: string, stream: Readable): Promise<boolean>;
+    writeFile(assetKey: string, stream: ReadableStream | NodeJS.ReadableStream): Promise<boolean>;
     copyFile(assetKey: string, fromAbsolutePath: string): Promise<boolean>;
-    readFile(assetKey: string): Promise<ReadStream>;
+    readFile(assetKey: string): Promise<ReadableStream | NodeJS.ReadableStream>;
     deleteFile(assetKey: string): Promise<boolean>;
     private createDirectoryForFile;
 }