ocpp-ws-io 2.2.1 → 2.2.2

package/dist/nestjs.d.mts

@@ -0,0 +1,169 @@
+import { a0 as ServerOptions, Y as RouterConfig, a as OCPPServerClient, o as CORSOptions, M as MiddlewareFunction, O as OCPPServer, b as OCPPServerStats, c as OCPPProtocol, A as AllMethodNames, d as OCPPRequestType, C as CallOptions, e as OCPPResponseType, f as CloseOptions } from './types-xFfIgIuS.mjs';
+import { IncomingMessage } from 'node:http';
+import { Type, DynamicModule, ForwardReference, OnModuleInit, OnModuleDestroy, NestMiddleware } from '@nestjs/common';
+import { HttpAdapterHost, DiscoveryService, MetadataScanner } from '@nestjs/core';
+import 'ws';
+import 'node:https';
+import 'node:events';
+import 'node:stream';
+import 'node:tls';
+import 'voltlog-io';
+import 'ajv';
+
+declare const OCPP_GATEWAY_METADATA = "ocpp:gateway";
+declare const OCPP_MESSAGE_EVENT_METADATA = "ocpp:message_event";
+declare const OCPP_WILDCARD_EVENT_METADATA = "ocpp:wildcard_event";
+declare const OCPP_AUTH_METADATA = "ocpp:auth";
+declare const OCPP_CONNECTION_MIDDLEWARE_METADATA = "ocpp:connection_middleware";
+declare const OCPP_RPC_MIDDLEWARE_METADATA = "ocpp:rpc_middleware";
+declare const OCPP_CORS_METADATA = "ocpp:cors";
+declare const PARAM_ARGS_METADATA = "ocpp:params_args";
+declare const OCPP_SERVER_OPTIONS = "OCPP_SERVER_OPTIONS";
+declare const OCPP_SERVER_INSTANCE = "OCPP_SERVER_INSTANCE";
+
+interface OcppGatewayOptions extends RouterConfig {
+    path?: string;
+}
+interface OcppNestOptions {
+    /**
+     * Automatically attach the OCPP upgrade handler to Nest's HTTP server.
+     * Defaults to true.
+     */
+    autoAttach?: boolean;
+    /**
+     * Only pass matching upgrade requests to OCPP. This is useful when the same
+     * Nest app also owns Socket.IO or other WebSocket gateways.
+     */
+    upgradePathPrefix?: string | string[];
+    /**
+     * Advanced upgrade filter. Return true to let OCPP handle the request.
+     */
+    upgradeFilter?: (pathname: string, req: IncomingMessage) => boolean;
+}
+type OcppModuleOptions = ServerOptions & OcppNestOptions;
+interface OcppOptionsFactory {
+    createOcppOptions(): Promise<OcppModuleOptions> | OcppModuleOptions;
+}
+interface OcppModuleAsyncOptions {
+    imports?: Array<Type<any> | DynamicModule | Promise<DynamicModule> | ForwardReference>;
+    inject?: any[];
+    useFactory?: (...args: any[]) => Promise<OcppModuleOptions> | OcppModuleOptions;
+    useClass?: Type<OcppOptionsFactory>;
+    useExisting?: Type<OcppOptionsFactory>;
+}
+interface OnOcppClientConnected {
+    onOcppClientConnected(client: OCPPServerClient): void | Promise<void>;
+}
+interface OnOcppClientDisconnected {
+    onOcppClientDisconnected(client: OCPPServerClient, code: number, reason: string): void | Promise<void>;
+}
+interface OnOcppClientError {
+    onOcppClientError(client: OCPPServerClient, error: Error): void | Promise<void>;
+}
+declare enum OcppParamType {
+    CLIENT = 0,
+    MESSAGE = 1,
+    PARAMS = 2,
+    CONTEXT = 3,
+    IDENTITY = 4,
+    PATH = 5,
+    SESSION = 6,
+    PATH_PARAMS = 7,
+    PROTOCOL = 8,
+    MESSAGE_ID = 9,
+    HANDSHAKE = 10
+}
+interface OcppParamMetadata {
+    type: OcppParamType;
+    data?: string;
+}
+
+declare const OcppGateway: (pathOrOptions?: string | OcppGatewayOptions) => ClassDecorator;
+declare const OcppCors: (options: CORSOptions) => ClassDecorator;
+declare const UseOcppRpcMiddleware: (...middlewares: MiddlewareFunction<any>[]) => ClassDecorator;
+
+interface OcppMessageEventMetadata {
+    action: string;
+    protocol?: string;
+}
+declare const OcppMessageEvent: (action: string, protocol?: string) => MethodDecorator;
+declare const OcppWildcardEvent: () => MethodDecorator;
+declare const OcppAuth: () => MethodDecorator;
+declare const OcppConnectionMiddleware: () => MethodDecorator;
+
+declare const Client: () => ParameterDecorator;
+declare const Message: () => ParameterDecorator;
+declare const Params: () => ParameterDecorator;
+declare const Context: () => ParameterDecorator;
+declare const Identity: () => ParameterDecorator;
+declare const Path: () => ParameterDecorator;
+declare const Session: () => ParameterDecorator;
+declare const PathParam: (name?: string) => ParameterDecorator;
+declare const Protocol: () => ParameterDecorator;
+declare const MessageId: () => ParameterDecorator;
+declare const Handshake: () => ParameterDecorator;
+
+declare class OcppService implements OnModuleInit, OnModuleDestroy {
+    private readonly ocppServer;
+    private readonly options;
+    private readonly httpAdapterHost?;
+    private attachedHttpServer?;
+    private readonly gatewayPatterns;
+    private acceptAllUpgrades;
+    private readonly upgradeHandler;
+    constructor(ocppServer: OCPPServer, options?: OcppModuleOptions, httpAdapterHost?: HttpAdapterHost | undefined);
+    onModuleInit(): void;
+    onModuleDestroy(): Promise<void>;
+    get server(): OCPPServer;
+    get clients(): ReadonlySet<OCPPServerClient>;
+    stats(): OCPPServerStats;
+    getClient(identity: string): OCPPServerClient | undefined;
+    getLocalClient(identity: string): OCPPServerClient | undefined;
+    hasLocalClient(identity: string): boolean;
+    hasClient(identity: string): Promise<boolean>;
+    sendToClient<V extends OCPPProtocol, M extends AllMethodNames<V>>(identity: string, version: V, method: M, params: OCPPRequestType<V, M>, options?: CallOptions): Promise<OCPPResponseType<V, M> | undefined>;
+    sendToClient<M extends AllMethodNames<any>>(identity: string, method: M, params: OCPPRequestType<any, M>, options?: CallOptions): Promise<OCPPResponseType<any, M> | undefined>;
+    sendToClient<TResult = any>(identity: string, method: string, params: Record<string, any>, options?: CallOptions): Promise<TResult | undefined>;
+    safeSendToClient<V extends OCPPProtocol, M extends AllMethodNames<V>>(identity: string, version: V, method: M, params: OCPPRequestType<V, M>, options?: CallOptions): Promise<OCPPResponseType<V, M> | undefined>;
+    safeSendToClient<M extends AllMethodNames<any>>(identity: string, method: M, params: OCPPRequestType<any, M>, options?: CallOptions): Promise<OCPPResponseType<any, M> | undefined>;
+    safeSendToClient<TResult = any>(identity: string, method: string, params: Record<string, any>, options?: CallOptions): Promise<TResult | undefined>;
+    close(options?: CloseOptions): Promise<void>;
+    registerUpgradePath(pattern?: string | RegExp): void;
+    private handleUpgrade;
+    private shouldHandleUpgrade;
+    private getPathname;
+    private normalizePrefixes;
+    private matchesPattern;
+}
+
+declare class OcppExplorer implements OnModuleInit {
+    private readonly discoveryService;
+    private readonly metadataScanner;
+    private readonly server;
+    private readonly service?;
+    private readonly logger;
+    constructor(discoveryService: DiscoveryService, metadataScanner: MetadataScanner, server: OCPPServer, service?: OcppService | undefined);
+    onModuleInit(): void;
+    explore(): void;
+    private executeWithParams;
+    private normalizeParamMetadata;
+}
+
+interface OcppRequest {
+    ocppServer: OCPPServer;
+    ocpp: OcppService;
+}
+declare class OcppMiddleware implements NestMiddleware {
+    private readonly ocppService;
+    constructor(ocppService: OcppService);
+    use(req: OcppRequest, _res: unknown, next: () => void): void;
+}
+
+declare class OcppModule {
+    readonly _isModule = true;
+    static forRoot(options?: OcppModuleOptions): DynamicModule;
+    static forRootAsync(options: OcppModuleAsyncOptions): DynamicModule;
+    private static createAsyncOptionsProvider;
+}
+
+export { Client, Context, Handshake, Identity, Message, MessageId, OCPP_AUTH_METADATA, OCPP_CONNECTION_MIDDLEWARE_METADATA, OCPP_CORS_METADATA, OCPP_GATEWAY_METADATA, OCPP_MESSAGE_EVENT_METADATA, OCPP_RPC_MIDDLEWARE_METADATA, OCPP_SERVER_INSTANCE, OCPP_SERVER_OPTIONS, OCPP_WILDCARD_EVENT_METADATA, OcppAuth, OcppConnectionMiddleware, OcppCors, OcppExplorer, OcppGateway, type OcppGatewayOptions, OcppMessageEvent, type OcppMessageEventMetadata, OcppMiddleware, OcppModule, type OcppModuleAsyncOptions, type OcppModuleOptions, type OcppNestOptions, type OcppOptionsFactory, type OcppParamMetadata, OcppParamType, type OcppRequest, OcppService, OcppWildcardEvent, type OnOcppClientConnected, type OnOcppClientDisconnected, type OnOcppClientError, PARAM_ARGS_METADATA, Params, Path, PathParam, Protocol, Session, UseOcppRpcMiddleware };

package/dist/nestjs.d.ts

@@ -0,0 +1,169 @@
+import { a0 as ServerOptions, Y as RouterConfig, a as OCPPServerClient, o as CORSOptions, M as MiddlewareFunction, O as OCPPServer, b as OCPPServerStats, c as OCPPProtocol, A as AllMethodNames, d as OCPPRequestType, C as CallOptions, e as OCPPResponseType, f as CloseOptions } from './types-xFfIgIuS.js';
+import { IncomingMessage } from 'node:http';
+import { Type, DynamicModule, ForwardReference, OnModuleInit, OnModuleDestroy, NestMiddleware } from '@nestjs/common';
+import { HttpAdapterHost, DiscoveryService, MetadataScanner } from '@nestjs/core';
+import 'ws';
+import 'node:https';
+import 'node:events';
+import 'node:stream';
+import 'node:tls';
+import 'voltlog-io';
+import 'ajv';
+
+declare const OCPP_GATEWAY_METADATA = "ocpp:gateway";
+declare const OCPP_MESSAGE_EVENT_METADATA = "ocpp:message_event";
+declare const OCPP_WILDCARD_EVENT_METADATA = "ocpp:wildcard_event";
+declare const OCPP_AUTH_METADATA = "ocpp:auth";
+declare const OCPP_CONNECTION_MIDDLEWARE_METADATA = "ocpp:connection_middleware";
+declare const OCPP_RPC_MIDDLEWARE_METADATA = "ocpp:rpc_middleware";
+declare const OCPP_CORS_METADATA = "ocpp:cors";
+declare const PARAM_ARGS_METADATA = "ocpp:params_args";
+declare const OCPP_SERVER_OPTIONS = "OCPP_SERVER_OPTIONS";
+declare const OCPP_SERVER_INSTANCE = "OCPP_SERVER_INSTANCE";
+
+interface OcppGatewayOptions extends RouterConfig {
+    path?: string;
+}
+interface OcppNestOptions {
+    /**
+     * Automatically attach the OCPP upgrade handler to Nest's HTTP server.
+     * Defaults to true.
+     */
+    autoAttach?: boolean;
+    /**
+     * Only pass matching upgrade requests to OCPP. This is useful when the same
+     * Nest app also owns Socket.IO or other WebSocket gateways.
+     */
+    upgradePathPrefix?: string | string[];
+    /**
+     * Advanced upgrade filter. Return true to let OCPP handle the request.
+     */
+    upgradeFilter?: (pathname: string, req: IncomingMessage) => boolean;
+}
+type OcppModuleOptions = ServerOptions & OcppNestOptions;
+interface OcppOptionsFactory {
+    createOcppOptions(): Promise<OcppModuleOptions> | OcppModuleOptions;
+}
+interface OcppModuleAsyncOptions {
+    imports?: Array<Type<any> | DynamicModule | Promise<DynamicModule> | ForwardReference>;
+    inject?: any[];
+    useFactory?: (...args: any[]) => Promise<OcppModuleOptions> | OcppModuleOptions;
+    useClass?: Type<OcppOptionsFactory>;
+    useExisting?: Type<OcppOptionsFactory>;
+}
+interface OnOcppClientConnected {
+    onOcppClientConnected(client: OCPPServerClient): void | Promise<void>;
+}
+interface OnOcppClientDisconnected {
+    onOcppClientDisconnected(client: OCPPServerClient, code: number, reason: string): void | Promise<void>;
+}
+interface OnOcppClientError {
+    onOcppClientError(client: OCPPServerClient, error: Error): void | Promise<void>;
+}
+declare enum OcppParamType {
+    CLIENT = 0,
+    MESSAGE = 1,
+    PARAMS = 2,
+    CONTEXT = 3,
+    IDENTITY = 4,
+    PATH = 5,
+    SESSION = 6,
+    PATH_PARAMS = 7,
+    PROTOCOL = 8,
+    MESSAGE_ID = 9,
+    HANDSHAKE = 10
+}
+interface OcppParamMetadata {
+    type: OcppParamType;
+    data?: string;
+}
+
+declare const OcppGateway: (pathOrOptions?: string | OcppGatewayOptions) => ClassDecorator;
+declare const OcppCors: (options: CORSOptions) => ClassDecorator;
+declare const UseOcppRpcMiddleware: (...middlewares: MiddlewareFunction<any>[]) => ClassDecorator;
+
+interface OcppMessageEventMetadata {
+    action: string;
+    protocol?: string;
+}
+declare const OcppMessageEvent: (action: string, protocol?: string) => MethodDecorator;
+declare const OcppWildcardEvent: () => MethodDecorator;
+declare const OcppAuth: () => MethodDecorator;
+declare const OcppConnectionMiddleware: () => MethodDecorator;
+
+declare const Client: () => ParameterDecorator;
+declare const Message: () => ParameterDecorator;
+declare const Params: () => ParameterDecorator;
+declare const Context: () => ParameterDecorator;
+declare const Identity: () => ParameterDecorator;
+declare const Path: () => ParameterDecorator;
+declare const Session: () => ParameterDecorator;
+declare const PathParam: (name?: string) => ParameterDecorator;
+declare const Protocol: () => ParameterDecorator;
+declare const MessageId: () => ParameterDecorator;
+declare const Handshake: () => ParameterDecorator;
+
+declare class OcppService implements OnModuleInit, OnModuleDestroy {
+    private readonly ocppServer;
+    private readonly options;
+    private readonly httpAdapterHost?;
+    private attachedHttpServer?;
+    private readonly gatewayPatterns;
+    private acceptAllUpgrades;
+    private readonly upgradeHandler;
+    constructor(ocppServer: OCPPServer, options?: OcppModuleOptions, httpAdapterHost?: HttpAdapterHost | undefined);
+    onModuleInit(): void;
+    onModuleDestroy(): Promise<void>;
+    get server(): OCPPServer;
+    get clients(): ReadonlySet<OCPPServerClient>;
+    stats(): OCPPServerStats;
+    getClient(identity: string): OCPPServerClient | undefined;
+    getLocalClient(identity: string): OCPPServerClient | undefined;
+    hasLocalClient(identity: string): boolean;
+    hasClient(identity: string): Promise<boolean>;
+    sendToClient<V extends OCPPProtocol, M extends AllMethodNames<V>>(identity: string, version: V, method: M, params: OCPPRequestType<V, M>, options?: CallOptions): Promise<OCPPResponseType<V, M> | undefined>;
+    sendToClient<M extends AllMethodNames<any>>(identity: string, method: M, params: OCPPRequestType<any, M>, options?: CallOptions): Promise<OCPPResponseType<any, M> | undefined>;
+    sendToClient<TResult = any>(identity: string, method: string, params: Record<string, any>, options?: CallOptions): Promise<TResult | undefined>;
+    safeSendToClient<V extends OCPPProtocol, M extends AllMethodNames<V>>(identity: string, version: V, method: M, params: OCPPRequestType<V, M>, options?: CallOptions): Promise<OCPPResponseType<V, M> | undefined>;
+    safeSendToClient<M extends AllMethodNames<any>>(identity: string, method: M, params: OCPPRequestType<any, M>, options?: CallOptions): Promise<OCPPResponseType<any, M> | undefined>;
+    safeSendToClient<TResult = any>(identity: string, method: string, params: Record<string, any>, options?: CallOptions): Promise<TResult | undefined>;
+    close(options?: CloseOptions): Promise<void>;
+    registerUpgradePath(pattern?: string | RegExp): void;
+    private handleUpgrade;
+    private shouldHandleUpgrade;
+    private getPathname;
+    private normalizePrefixes;
+    private matchesPattern;
+}
+
+declare class OcppExplorer implements OnModuleInit {
+    private readonly discoveryService;
+    private readonly metadataScanner;
+    private readonly server;
+    private readonly service?;
+    private readonly logger;
+    constructor(discoveryService: DiscoveryService, metadataScanner: MetadataScanner, server: OCPPServer, service?: OcppService | undefined);
+    onModuleInit(): void;
+    explore(): void;
+    private executeWithParams;
+    private normalizeParamMetadata;
+}
+
+interface OcppRequest {
+    ocppServer: OCPPServer;
+    ocpp: OcppService;
+}
+declare class OcppMiddleware implements NestMiddleware {
+    private readonly ocppService;
+    constructor(ocppService: OcppService);
+    use(req: OcppRequest, _res: unknown, next: () => void): void;
+}
+
+declare class OcppModule {
+    readonly _isModule = true;
+    static forRoot(options?: OcppModuleOptions): DynamicModule;
+    static forRootAsync(options: OcppModuleAsyncOptions): DynamicModule;
+    private static createAsyncOptionsProvider;
+}
+
+export { Client, Context, Handshake, Identity, Message, MessageId, OCPP_AUTH_METADATA, OCPP_CONNECTION_MIDDLEWARE_METADATA, OCPP_CORS_METADATA, OCPP_GATEWAY_METADATA, OCPP_MESSAGE_EVENT_METADATA, OCPP_RPC_MIDDLEWARE_METADATA, OCPP_SERVER_INSTANCE, OCPP_SERVER_OPTIONS, OCPP_WILDCARD_EVENT_METADATA, OcppAuth, OcppConnectionMiddleware, OcppCors, OcppExplorer, OcppGateway, type OcppGatewayOptions, OcppMessageEvent, type OcppMessageEventMetadata, OcppMiddleware, OcppModule, type OcppModuleAsyncOptions, type OcppModuleOptions, type OcppNestOptions, type OcppOptionsFactory, type OcppParamMetadata, OcppParamType, type OcppRequest, OcppService, OcppWildcardEvent, type OnOcppClientConnected, type OnOcppClientDisconnected, type OnOcppClientError, PARAM_ARGS_METADATA, Params, Path, PathParam, Protocol, Session, UseOcppRpcMiddleware };