@common-stack/server-stack 8.2.5-alpha.7 → 8.3.1-alpha.0

package/lib/inngest/middleware/types.d.ts

@@ -1,162 +0,0 @@
-/**
- * TypeScript type extensions for Inngest middleware-injected helpers
- *
- * These types extend the Inngest Step and Context objects with our custom helpers
- * that are injected by the function-reference middleware.
- *
- * Usage in your code:
- * ```typescript
- * import type { ExtendedStep, ExtendedContext } from '@common-stack/server-stack';
- *
- * const myFn = inngest.createFunction(..., async ({ event, ctx, step }: {
- *   event: any;
- *   ctx: ExtendedContext;
- *   step: ExtendedStep;
- * }) => {
- *   // Now you get autocomplete for ctx.resolveFunctionId and step.resolveFunctionId!
- *   const userFn = ctx.resolveFunctionId('USER.Create/trigger');
- *   await step.invoke('create-user', { function: userFn, data: {...} });
- * });
- * ```
- */
-import type { InngestFunction } from 'inngest';
-/**
- * Extended Context with injected function reference helpers
- */
-export interface ExtendedContext {
-    /**
-     * Reference a function by its exact ID
-     * @param functionId - The exact function ID (e.g., 'user-create')
-     */
-    resolveFunction<T extends InngestFunction.Any = InngestFunction.Any>(functionId: string | {
-        functionId: string;
-    }): T;
-    /**
-     * Resolve a function reference from a workflow-style string or plain ID
-     * Normalizes strings like "WORKFLOWNAME.Function/trigger" to "workflowname-function-trigger"
-     * @param functionRef - Workflow-style string or plain function ID
-     */
-    resolveFunctionId<T extends InngestFunction.Any = InngestFunction.Any>(functionRef: string | {
-        functionId: string;
-    }): T;
-    /**
-     * Batch reference multiple functions at once
-     * @param functionIds - Array of function IDs to reference
-     */
-    resolveFunctions<T extends readonly string[]>(functionIds: T): {
-        [K in T[number]]: InngestFunction.Any;
-    };
-    /**
-     * Check if a function is registered in the global registry
-     * @param functionId - The function ID to check
-     */
-    hasFunction(functionId: string): boolean;
-    /**
-     * Get all available function IDs from the registry
-     */
-    getAvailableFunctions(): string[];
-}
-/**
- * Extended Step with injected function reference helpers
- *
- * These are available on the step object for inline editors that can't import modules.
- */
-export interface ExtendedStep {
-    /**
-     * Reference a function by its exact ID
-     * Available on step object for inline editor support (no imports needed)
-     * @param functionId - The exact function ID (e.g., 'user-create')
-     *
-     * @example
-     * ```typescript
-     * const step_159 = async (event, step) => {
-     *   const userFn = step.referenceFunction('user-create');
-     *   await step.invoke('create-user', { function: userFn, data: {...} });
-     * };
-     * ```
-     */
-    referenceFunction<T extends InngestFunction.Any = InngestFunction.Any>(functionId: string | {
-        functionId: string;
-    }): T;
-    /**
-     * Resolve a function reference from a workflow-style string or plain ID
-     * Available on step object for inline editor support (no imports needed)
-     * Normalizes strings like "WORKFLOWNAME.Function/trigger" to "workflowname-function-trigger"
-     * @param functionRef - Workflow-style string or plain function ID
-     *
-     * @example
-     * ```typescript
-     * const step_159 = async (event, step) => {
-     *   // Workflow-style reference
-     *   const paymentFn = step.resolveFunctionId('BILLING.ProcessPayment/trigger');
-     *   await step.invoke('process-payment', { function: paymentFn, data: {...} });
-     * };
-     * ```
-     */
-    resolveFunctionId<T extends InngestFunction.Any = InngestFunction.Any>(functionRef: string | {
-        functionId: string;
-    }): T;
-    /**
-     * Check if a function is registered in the global registry
-     * Available on step object for inline editor support (no imports needed)
-     * @param functionId - The function ID to check
-     *
-     * @example
-     * ```typescript
-     * const step_159 = async (event, step) => {
-     *   if (step.hasFunction('email-send')) {
-     *     const emailFn = step.referenceFunction('email-send');
-     *     await step.invoke('send-email', { function: emailFn, data: {...} });
-     *   }
-     * };
-     * ```
-     */
-    hasFunction(functionId: string): boolean;
-    /**
-     * Get all available function IDs from the registry
-     * Available on step object for inline editor support (no imports needed)
-     *
-     * @example
-     * ```typescript
-     * const step_159 = async (event, step) => {
-     *   console.log('Available functions:', step.getAvailableFunctions());
-     * };
-     * ```
-     */
-    getAvailableFunctions(): string[];
-    invoke: any;
-    run: any;
-    sleep: any;
-    sleepUntil: any;
-    waitForEvent: any;
-    sendEvent: any;
-    [key: string]: any;
-}
-/**
- * Helper type for inline editor function handlers
- * Use this for your inline editor functions to get full autocomplete
- *
- * @example
- * ```typescript
- * const step_159: InlineEditorHandler = async (event, step) => {
- *   // Full autocomplete for step.resolveFunctionId, step.referenceFunction, etc!
- *   const userFn = step.resolveFunctionId('USER.Create/trigger');
- *   await step.invoke('create-user', { function: userFn, data: {...} });
- *   return { success: true };
- * };
- * ```
- */
-export type InlineEditorHandler = (event: any, step: ExtendedStep) => Promise<any>;
-/**
- * Full context handler with both ctx and step extended
- *
- * @example
- * ```typescript
- * const myHandler: FullContextHandler = async (event, ctx, step) => {
- *   const userFn = ctx.resolveFunctionId('USER.Create/trigger');
- *   await step.invoke('create-user', { function: userFn, data: {...} });
- *   return { success: true };
- * };
- * ```
- */
-export type FullContextHandler = (event: any, ctx: ExtendedContext, step: ExtendedStep) => Promise<any>;

package/lib/inngest/multi-module-functions.d.ts

@@ -1,133 +0,0 @@
-import { Container } from 'inversify';
-/**
- * User management Inngest functions that depend on container services
- */
-export declare const userInngestFunctions: ({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    createUserFunction: {
-        id: string;
-        _type: string;
-    };
-    updateUserProfileFunction: {
-        id: string;
-        _type: string;
-    };
-};
-/**
- * Email campaign Inngest functions that depend on container services
- */
-export declare const emailCampaignInngestFunctions: ({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    sendCampaignFunction: {
-        id: string;
-        _type: string;
-    };
-    trackEmailOpenFunction: {
-        id: string;
-        _type: string;
-    };
-};
-/**
- * Analytics Inngest functions that depend on container services
- */
-export declare const analyticsInngestFunctions: ({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    generateReportFunction: {
-        id: string;
-        _type: string;
-    };
-    trackUserEventFunction: {
-        id: string;
-        _type: string;
-    };
-};
-/**
- * AI Page Creator functions that depend on container services
- */
-export declare const aiPageCreatorInngestFunctions: ({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    codeAgentFunction: {
-        id: string;
-        _type: string;
-    };
-    sendMessageFunction: {
-        id: string;
-        _type: string;
-    };
-    processPageFunction: {
-        id: string;
-        _type: string;
-    };
-};
-/**
- * Export array of all function factories for easy registration
- */
-export declare const allInngestFunctionFactories: ((({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    createUserFunction: {
-        id: string;
-        _type: string;
-    };
-    updateUserProfileFunction: {
-        id: string;
-        _type: string;
-    };
-}) | (({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    sendCampaignFunction: {
-        id: string;
-        _type: string;
-    };
-    trackEmailOpenFunction: {
-        id: string;
-        _type: string;
-    };
-}) | (({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    generateReportFunction: {
-        id: string;
-        _type: string;
-    };
-    trackUserEventFunction: {
-        id: string;
-        _type: string;
-    };
-}) | (({ container, inngest, settings, }: {
-    container: Container;
-    inngest: any;
-    settings?: any;
-}) => {
-    codeAgentFunction: {
-        id: string;
-        _type: string;
-    };
-    sendMessageFunction: {
-        id: string;
-        _type: string;
-    };
-    processPageFunction: {
-        id: string;
-        _type: string;
-    };
-}))[];

package/lib/inngest/setup.d.ts

@@ -1,10 +0,0 @@
-import { Express } from 'express';
-import { Container } from 'inversify';
-import { CdmLogger } from '@cdm-logger/core';
-import { Feature } from '@common-stack/server-core';
-type ILogger = CdmLogger.ILogger;
-/**
- * Sets up Inngest functions from the Feature system and registers the handler
- */
-export declare function setupInngestFunctions(modules: Feature, app: Express, serviceContainer: Container, logger: ILogger): Promise<void>;
-export {};

package/lib/interfaces/dbMigration.d.ts

@@ -1,8 +0,0 @@
-export interface IDatabaseMigration {
-    /**
-     * ID of the migration, and it should be changed inorder to overwrite previous migration
-     */
-    id: string;
-    up?(): Promise<void>;
-    down?(): Promise<void>;
-}

package/lib/interfaces/graphql-request-context.d.ts

@@ -1,20 +0,0 @@
-import type { ServiceBroker } from 'moleculer';
-export type GraphqlRequestContext = {
-    overallCachePolicy: {
-        scope: string;
-        maxAge: number;
-    };
-    user: {
-        sub: string;
-    };
-    req: {
-        currentPageUriSegments: {
-            authority: string;
-        };
-        tenant?: string;
-    };
-    queriesToInvalidate: string[];
-    tenantId?: string;
-    accountId?: string;
-    moleculerBroker?: ServiceBroker;
-};

package/lib/interfaces/index.d.ts

@@ -1,4 +0,0 @@
-export * from './moleculer';
-export * from './module-interface';
-export * from './dbMigration';
-export * from './graphql-request-context';

package/lib/interfaces/module-interface.d.ts

@@ -1,13 +0,0 @@
-import { GraphQLSchema } from 'graphql';
-import { CdmLogger } from '@cdm-logger/core';
-type ILogger = CdmLogger.ILogger;
-export interface IModuleService {
-    serviceContainer: any;
-    serviceContext: any;
-    dataSource: any;
-    defaultPreferences: any;
-    createContext: any;
-    schema: GraphQLSchema;
-    logger: ILogger;
-}
-export {};

package/lib/interfaces/moleculer.d.ts

@@ -1,7 +0,0 @@
-import { GenericObject, Transporter } from 'moleculer';
-type TransporterOptions = {
-    options: any;
-    type: string;
-};
-export type TransporterType = Transporter | string | GenericObject | TransporterOptions | null;
-export {};

package/lib/middleware/cors.d.ts

@@ -1,6 +0,0 @@
-import cors from 'cors';
-export declare const corsMiddleware: (req: cors.CorsRequest, res: {
-    statusCode?: number | undefined;
-    setHeader(key: string, value: string): any;
-    end(): any;
-}, next: (err?: any) => any) => void;

package/lib/middleware/error.d.ts

@@ -1,9 +0,0 @@
-/**
- * Middleware function that takes 4 arguments is classified as "error handling middleware"
- * and will only get called if an error occurs.
- * @param e
- * @param req
- * @param res
- * @param next
- */
-export declare const errorMiddleware: (e: any, req: any, res: any, next: any) => void;

package/lib/middleware/index.d.ts

@@ -1,5 +0,0 @@
-export { redisClientMiddleware } from './redis-client';
-export { contextServicesMiddleware } from './services';
-export { corsMiddleware } from './cors';
-export { errorMiddleware } from './error';
-export { sentryMiddleware, sentryErrorHandlerMiddleware } from './sentry';

package/lib/middleware/moleculer-inter-namespace.d.ts

@@ -1,2 +0,0 @@
-import { Middleware } from 'moleculer';
-export declare const InterNamespaceMiddleware: (options: any) => Middleware;

package/lib/middleware/redis-client.d.ts

@@ -1,16 +0,0 @@
-/**
- * Redis Client Middleware
- *
- * This middleware attaches the Redis client to the request object,
- * making it available for session storage and other Redis operations.
- */
-import { Request, Response, NextFunction } from 'express';
-export interface RedisClientRequest extends Request {
-    redisClient?: any;
-}
-/**
- * Creates middleware that attaches Redis client to request object
- * @param redisClient - The Redis client instance
- * @returns Express middleware function
- */
-export declare function redisClientMiddleware(redisClient: any): (req: RedisClientRequest, res: Response, next: NextFunction) => void;

package/lib/middleware/sentry.d.ts

@@ -1,2 +0,0 @@
-export declare const sentryMiddleware: (req: import("http").IncomingMessage, res: import("http").ServerResponse, next: (error?: any) => void) => void;
-export declare const sentryErrorHandlerMiddleware: any;

package/lib/middleware/services.d.ts

@@ -1,2 +0,0 @@
-import 'isomorphic-fetch';
-export declare const contextServicesMiddleware: (createContext: any, serviceContext: any) => (req: any, res: any, next: any) => void;

package/lib/plugins/index.d.ts

@@ -1,2 +0,0 @@
-export * from './invalidateCachePlugin';
-export { responseCachePlugin } from './responseCachePlugin';

package/lib/plugins/invalidateCachePlugin.d.ts

@@ -1,8 +0,0 @@
-import { Redis, Cluster } from 'ioredis';
-import type { BaseContext, GraphQLRequestContextWillSendResponse } from '@apollo/server';
-import { ApolloServerOptions, GraphQLRequestContext } from '@apollo/server';
-export type InvalidationKeyGenerator = (requestContext: GraphQLRequestContext<unknown>, responseContext: GraphQLRequestContextWillSendResponse<unknown>, cacheKey?: string) => string;
-export declare const invalidateCachePlugin: ({ cache: redisClient, invalidateCacheKeyGenerator, }: {
-    cache: Redis | Cluster;
-    invalidateCacheKeyGenerator: InvalidationKeyGenerator;
-}) => ApolloServerOptions<BaseContext>["plugins"][0];

package/lib/plugins/responseCachePlugin.d.ts

@@ -1,12 +0,0 @@
-import { GraphQLRequestContext } from '@apollo/server';
-import { ILogger } from '@cdm-logger/core/lib/interface';
-import { GraphqlRequestContext } from '../interfaces';
-import { KeyGenerator } from '../servers/GraphqlServer';
-type ApolloCachePluginOptions = {
-    logger: ILogger;
-    cacheKeyGenerator: KeyGenerator;
-};
-export declare const isCacheable: (requestContext: GraphQLRequestContext<GraphqlRequestContext>) => boolean;
-export declare const generateCacheKey: ({ logger, cacheKeyGenerator }: ApolloCachePluginOptions) => (requestContext: GraphQLRequestContext<GraphqlRequestContext>) => string;
-export declare const responseCachePlugin: ({ logger, cacheKeyGenerator }: ApolloCachePluginOptions) => any;
-export {};

package/lib/servers/ExpressApp.d.ts

@@ -1,3 +0,0 @@
-import { Feature } from '@common-stack/server-core';
-import { IModuleService } from '../interfaces';
-export declare function expressApp(modules: Feature, options: IModuleService, middlewares: any, http?: any, redisClient?: any): import("express-serve-static-core").Express;

package/lib/servers/GraphqlServer.d.ts

@@ -1,25 +0,0 @@
-import { GraphQLRequestContext } from '@apollo/server';
-import * as IORedis from 'ioredis';
-import 'isomorphic-fetch';
-import { Express } from 'express';
-import * as http from 'http';
-import { InvalidationKeyGenerator } from '../plugins';
-import { IModuleService } from '../interfaces';
-import type { ApolloServerPlugin } from '@apollo/server';
-export type KeyGenerator = (context: GraphQLRequestContext<unknown>, cacheKey?: string) => string;
-export declare class GraphqlServer {
-    private readonly app;
-    private readonly httpServer;
-    private readonly redisClient;
-    private readonly moduleService;
-    private readonly enableSubscription;
-    private readonly cacheKeyGenerator?;
-    private readonly invalidateCacheKeyGenerator?;
-    private readonly plugins?;
-    private logger;
-    private graphqlWsServer;
-    constructor(app: Express, httpServer: http.Server, redisClient: IORedis.Redis | IORedis.Cluster, moduleService: IModuleService, enableSubscription?: boolean, cacheKeyGenerator?: KeyGenerator, invalidateCacheKeyGenerator?: InvalidationKeyGenerator, plugins?: ApolloServerPlugin<any>[]);
-    initialize(): Promise<void>;
-    getUserIpAddress(req: any): any;
-    private configureApolloServer;
-}

package/lib/servers/GraphqlWs.d.ts

@@ -1,14 +0,0 @@
-import * as IORedis from 'ioredis';
-import { Disposable } from 'graphql-ws';
-import { WebSocketServer } from 'ws';
-import { IModuleService } from '../interfaces';
-export declare class GraphqlWs {
-    private wsServer;
-    private moduleService;
-    protected cache: IORedis.Redis | IORedis.Cluster;
-    private subscriptionServer;
-    private logger;
-    constructor(wsServer: WebSocketServer, moduleService: IModuleService, cache: IORedis.Redis | IORedis.Cluster);
-    create(): Disposable;
-    disconnect(): void;
-}

package/lib/servers/WebsocketMultipathUpdate.d.ts

@@ -1,18 +0,0 @@
-import { WebSocketServer } from 'ws';
-import { Server } from 'http';
-import * as IORedis from 'ioredis';
-import { IModuleService } from '../interfaces';
-interface MultiWebsocketConfig {
-    [key: string]: any;
-}
-export declare class WebsocketMultiPathServer {
-    moduleService: IModuleService;
-    cache: IORedis.Redis | IORedis.Cluster;
-    private webSockets;
-    private _graphqlWs;
-    constructor(moduleService: IModuleService, cache: IORedis.Redis | IORedis.Cluster, multiplePathConfig?: MultiWebsocketConfig);
-    httpServerUpgrade(httpServer: Server): Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse>;
-    get graphqlWs(): WebSocketServer;
-    close(): void;
-}
-export {};

package/lib/servers/mongodb-migration-update.d.ts

@@ -1,12 +0,0 @@
-import { Schema, Connection as DBConnection } from 'mongoose';
-import { IModuleService } from '../interfaces';
-export declare const MigrationSchema: Schema<any, import("mongoose").Model<any, any, any, any, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, {
-    name: string;
-    migrated_at?: Date;
-}>;
-export declare class MongoDBMigrationUpgrade {
-    private moduleService;
-    private mongoDB;
-    constructor(moduleService: IModuleService, mongoDB: DBConnection);
-    migrate(): Promise<any>;
-}

package/lib/servers/utils.d.ts

@@ -1,14 +0,0 @@
-import * as IORedis from 'ioredis';
-import { CdmLogger } from '@cdm-logger/core';
-type ILogger = CdmLogger.ILogger;
-/**
- * It'll get messy below but there's an issue currently with the state of the protocols that can be used (subscriptions-transport-ws vs graphql-ws).
- * Read more from: https://www.apollographql.com/docs/apollo-server/data/subscriptions/#the-graphql-ws-transport-library
- *
- * Bottomline is, if we use the newer and actively maintained `graphql-ws` lib, then the GraphQL Playground will not work because it uses the old protocol.
- *
- * The approach below tries to support both based on the template provided here but adjusted for our setup here.
- * https://github.com/enisdenjo/graphql-ws#ws-backwards-compat
- */
-export declare function createContextFromConnectionParams(context: any, datasources: any, cache: IORedis.Redis | IORedis.Cluster, logger: ILogger): Promise<any>;
-export {};

package/lib/servers/websocket-context.d.ts

@@ -1,30 +0,0 @@
-import * as IORedis from 'ioredis';
-import { IModuleService } from '../interfaces';
-/**
- * Helper function to construct data sources for WebSocket subscriptions
- *
- * @workaround DataSources are an Apollo Server feature that only work with HTTP requests.
- * When using graphql-ws for WebSocket subscriptions, we must manually initialize data sources
- * because graphql-ws has a separate context pipeline from Apollo Server's HTTP pipeline.
- *
- * This is necessary as of:
- * - Apollo Server v4.10.4
- * - graphql-ws v5.11.2
- *
- * References:
- * - Original issue: https://github.com/apollographql/apollo-server/issues/1526
- * - Community solution: https://github.com/apollographql/apollo-server/issues/1526#issuecomment-502884432
- * - graphql-ws context: https://github.com/enisdenjo/graphql-ws#context
- */
-export declare const constructDataSourcesForSubscriptions: (context: any, cache: any, dataSources: any) => any;
-/**
- * Creates the WebSocket subscription context
- * This function is shared between GraphqlWs and WebsocketMultiPathServer
- * to ensure consistent context creation across all subscription endpoints.
- *
- * @param ctx - The graphql-ws context containing connectionParams
- * @param moduleService - The module service for creating context
- * @param cache - Redis cache instance
- * @returns Promise<object> - The complete subscription context
- */
-export declare function createWebSocketContext(ctx: any, moduleService: IModuleService, cache: IORedis.Redis | IORedis.Cluster): Promise<any>;

package/lib/utils/add-shareable-directive-to-schema.d.ts

@@ -1 +0,0 @@
-export declare const addShareableDirectiveToSchema: (schemaString: string) => string;

package/lib/utils/index.d.ts

@@ -1,3 +0,0 @@
-export * from './migrations';
-export * from './add-shareable-directive-to-schema';
-export * from './safe-model-factory';

package/lib/utils/migrations.d.ts

@@ -1,8 +0,0 @@
-import { Schema, Connection } from 'mongoose';
-import { Container } from 'inversify';
-import { CdmLogger } from '@cdm-logger/core';
-export declare const MigrationSchema: Schema<any, import("mongoose").Model<any, any, any, any, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, {
-    name: string;
-    migrated_at?: Date;
-}>;
-export declare function migrate(db: Connection, container: Container, logger: CdmLogger.ILogger): Promise<void>;

package/lib/utils/safe-model-factory.d.ts

@@ -1,18 +0,0 @@
-import { Connection, Model, Schema } from 'mongoose';
-/**
- * Safely creates or retrieves a Mongoose model, preventing "Cannot overwrite model once compiled" errors
- *
- * @param db - MongoDB connection
- * @param modelName - Name of the model
- * @param schema - Mongoose schema (only used if model doesn't exist)
- * @returns The Mongoose model
- */
-export declare function safeModelFactory<T = any>(db: Connection, modelName: string, schema?: Schema<T>): Model<T>;
-/**
- * Creates a model factory function that uses safe model registration
- *
- * @param modelName - Name of the model
- * @param schema - Mongoose schema
- * @returns A factory function that safely creates/retrieves the model
- */
-export declare function createSafeModelFactory<T = any>(modelName: string, schema: Schema<T>): (db: Connection) => Model<T>;