@cloudnux/core-cloud-provider 0.17.0 → 0.18.0

package/dist/index.d.ts

@@ -500,6 +500,14 @@ interface FunctionsService {
     buildInvokeResponse(invokeFunctionContext: InvokeFunctionContext, ...args: any[]): any;
 }
 
+/**
+ * Thrown when a sendToClient/disconnect is attempted against a connectionId
+ * that is no longer connected (AWS API Gateway GoneException equivalent, HTTP 410).
+ */
+declare class WebSocketConnectionGoneError extends Error {
+    readonly connectionId: string;
+    constructor(connectionId: string);
+}
 interface WebSocketService {
     /**
      * Send a message to a specific connected client
@@ -524,4 +532,4 @@ interface CloudProvider {
     createInvokeService(): InvokeService;
 }
 
-export { type BaseEntry, type CloudProvider, type Coordinates, type Entry, type Entrypoint, ErrorCode, type EventBatchItemResult, type EventBrokerService, type EventEntry, type EventFunctionContext, type EventMessage, type EventRequest, type EventResponse, type EventTrigger, type FunctionContext, type FunctionsService, type HTTPAuth, type HTTPRequest, type HTTPResponse, type HandlerType, type HttpEntry, type HttpFunctionContext, type HttpMethod, type HttpTrigger, type InvokeEntry, type InvokeFunctionContext, type InvokeRequest, type InvokeResponse, type InvokeService, type InvokeTrigger, type LocationAddress, type LocationProviderConfig, type LocationService, type LocationSuggestion, type MessageFilter, type PeekOptions, type PublishOptions, type ReadOptions, type ReverseGeocodeParams, type RoutePoint, type RouteResult, type ScheduleEntry, type ScheduleFunctionContext, type ScheduleRequest, type ScheduleResponse, type ScheduleTrigger, type StorageService, type StorageWriteOptions, type StorageWriteResult, type SuggestionParams, type WebSocketEntry, type WebSocketEvent, type WebSocketFunctionContext, type WebSocketRequest, type WebSocketResponse, type WebSocketService, type WebSocketTrigger };
+export { type BaseEntry, type CloudProvider, type Coordinates, type Entry, type Entrypoint, ErrorCode, type EventBatchItemResult, type EventBrokerService, type EventEntry, type EventFunctionContext, type EventMessage, type EventRequest, type EventResponse, type EventTrigger, type FunctionContext, type FunctionsService, type HTTPAuth, type HTTPRequest, type HTTPResponse, type HandlerType, type HttpEntry, type HttpFunctionContext, type HttpMethod, type HttpTrigger, type InvokeEntry, type InvokeFunctionContext, type InvokeRequest, type InvokeResponse, type InvokeService, type InvokeTrigger, type LocationAddress, type LocationProviderConfig, type LocationService, type LocationSuggestion, type MessageFilter, type PeekOptions, type PublishOptions, type ReadOptions, type ReverseGeocodeParams, type RoutePoint, type RouteResult, type ScheduleEntry, type ScheduleFunctionContext, type ScheduleRequest, type ScheduleResponse, type ScheduleTrigger, type StorageService, type StorageWriteOptions, type StorageWriteResult, type SuggestionParams, WebSocketConnectionGoneError, type WebSocketEntry, type WebSocketEvent, type WebSocketFunctionContext, type WebSocketRequest, type WebSocketResponse, type WebSocketService, type WebSocketTrigger };

package/dist/index.js

@@ -15,7 +15,18 @@ var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
   ErrorCode2["UNKNOWN_ERROR"] = "UNKNOWN_ERROR";
   return ErrorCode2;
 })(ErrorCode || {});
+
+// src/services/websocket.ts
+var WebSocketConnectionGoneError = class extends Error {
+  connectionId;
+  constructor(connectionId) {
+    super(`WebSocket connection ${connectionId} is gone`);
+    this.name = "WebSocketConnectionGoneError";
+    this.connectionId = connectionId;
+  }
+};
 export {
-  ErrorCode
+  ErrorCode,
+  WebSocketConnectionGoneError
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/services/functions.ts"],"sourcesContent":["import { HandlerType, HttpMethod, WebSocketEvent } from \"../entrypoint\";\n\n/**\n * Represents the context object for a function handler.\n */\nexport type FunctionContext = {\n    /**\n     * The underlying context handler type.\n     */\n    type: HandlerType;\n\n    /**\n     * Creates a success response. This should be called when the handler is done successfully.\n     * @param data - The response body.\n     */\n    success<T>(data: T): void;\n\n    /**\n     * Creates a server error response. This should be called when the handler encounters an unexpected error.\n     * @param err - The error object.\n     */\n    serverError(err: Error): void;\n    /**\n     * Creates an error response. This should be called when the handler is done with an error.\n     * @param message - The response body.\n     * \n     */\n    error(message: string, code?: ErrorCode, details?: Record<string, any>, stack?: string): void;\n    /**\n     * Creates a not found response. This should be called when the requested resource is not found.\n     * @param resource - The name of the resource that was not found.\n     * @param id - The id of the resource that was not found (optional).\n     */\n    notFound(resource: string, id?: string | number): void;\n};\n\n/**\n * Error codes for API error responses\n */\nexport enum ErrorCode {\n    // Validation errors\n    VALIDATION_ERROR = 'VALIDATION_ERROR',\n    INVALID_INPUT = 'INVALID_INPUT',\n\n    // Authentication errors\n    UNAUTHORIZED = 'UNAUTHORIZED',\n    ACCESS_DENIED = 'ACCESS_DENIED',\n\n    // Resource errors\n    RESOURCE_NOT_FOUND = 'RESOURCE_NOT_FOUND',\n    RESOURCE_ALREADY_EXISTS = 'RESOURCE_ALREADY_EXISTS',\n    RESOURCE_CONFLICT = 'RESOURCE_CONFLICT',\n\n    // System errors\n    INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',\n    SERVICE_UNAVAILABLE = 'SERVICE_UNAVAILABLE',\n    DATABASE_ERROR = 'DATABASE_ERROR',\n\n    // Business logic errors\n    BUSINESS_RULE_VIOLATION = 'BUSINESS_RULE_VIOLATION',\n\n    // External API errors\n    EXTERNAL_API_ERROR = 'EXTERNAL_API_ERROR',\n\n    // Other errors\n    UNKNOWN_ERROR = 'UNKNOWN_ERROR'\n}\n\n//#region [ Http ]\n\nexport type HTTPRequest = {\n    method: HttpMethod;\n    body?: string;\n    headers: Record<string, string | string[] | undefined>;\n    url: string;\n    params: Record<string, string | undefined>\n    matchingKey?: string;\n    rawQueryString?: string,\n    requestId?: string,\n    host?: string\n};\n\nexport type HTTPResponse = {\n    headers?: Record<string, string | string[] | undefined>;\n    body?: string;\n    status: number;\n};\n\nexport type HTTPAuth = {\n    token: string;\n    appId: string;\n    memberId: string;\n    customerId: string;\n    claims: Record<string, string>;\n    identity: \"facebook\" | \"google\" | \"apple\" | \"password\";\n};\n\nexport type HttpFunctionContext = FunctionContext & {\n    type: \"Http\";\n    request: HTTPRequest;\n    auth?: HTTPAuth;\n    response: HTTPResponse;\n    model<T = Record<string, any>>(): T;\n    params<T = Record<string, string>>(): T;\n\n    list<T>(items: T[], page: number, pageSize: number, totalItems: number): void;\n    cursorList<T>(items: T[], nextCursor: string | null, pageSize: number, prevCursor?: string | null): void;\n    created<T>(data: T): void;\n    deleted(id?: string | number): void;\n    validationError(details: Record<string, any>): void;\n    serverError(err: Error): void;\n    businessError(message: string, details?: Record<string, any>): void;\n\n    unauthorized(message?: string): void;\n    forbidden(message?: string): void;\n    output(status: number, body?: string | object, headers?: Record<string, string | string[]>): void;\n}\n\n//#endregion\n\n//#region [Schedule]\n\nexport type ScheduleResponse = {\n    status: \"success\" | \"error\",\n    body?: string | Record<string, any>;\n}\n\nexport type ScheduleRequest = {\n    name: string,\n    requestId?: string\n};\n\nexport type ScheduleFunctionContext = FunctionContext & {\n    response: ScheduleResponse;\n    request: ScheduleRequest;\n    type: \"Schedule\";\n}\n//#endregion\n\n//#region [Event]\nexport type EventRequest = {\n    body: string | Record<string, any>,\n    attributes: Record<string, string>,\n    requestId?: string,\n    timestamp: Date,\n    attempts?: number;\n}\n\nexport type EventResponse = {\n    status: \"success\" | \"error\",\n    code?: ErrorCode,\n    body?: Record<string, any>\n    stack?: string,\n    retryDelay?: number,\n};\n\nexport type EventFunctionContext = FunctionContext & {\n    type: \"Event\";\n    timestamp: Date;\n    attempts?: number;\n    request: EventRequest;\n    response: EventResponse;\n    message<T = Record<string, any>>(): T;\n    attributes<T = Record<string, any>>(): T;\n    retryWithDelay(seconds: number): void;\n}\n\nexport type EventBatchItemResult = { failureId: string } | undefined;\n//#endregion\n\n//#region [Invoke]\nexport type InvokeRequest = {\n    payload: any,\n    calledModule: string,\n    invokeTriggerName: string,\n    requestId?: string,\n}\n\nexport type InvokeResponse = {\n    status: \"success\" | \"error\",\n    body?: any,\n    code?: ErrorCode,\n}\n\nexport type InvokeFunctionContext = FunctionContext & {\n    type: \"Invoke\";\n    request: InvokeRequest;\n    response: InvokeResponse;\n    payload<T = Record<string, any>>(): T;\n}\n//#endregion\n\n//#region [WebSocket]\nexport type WebSocketRequest = {\n    connectionId: string,\n    event: WebSocketEvent,\n    route?: string,\n    url?: string,\n    params: Record<string, string | undefined> | null,\n    body?: string | Record<string, any> | null,\n    headers?: Record<string, string | string[] | undefined>,\n    queryString: Record<string, string | undefined> | null,\n    requestId?: string,\n}\n\nexport type WebSocketResponse = {\n    status: \"success\" | \"error\",\n    statusCode?: number,\n    body?: any,\n}\n\nexport type WebSocketFunctionContext = FunctionContext & {\n    type: \"WebSocket\";\n    connectionId: string;\n    event: WebSocketEvent;\n    request: WebSocketRequest;\n    response: WebSocketResponse;\n    message<T = Record<string, any>>(): T;\n    params<T = Record<string, string>>(): T;\n    unauthorized(body?: any): void;\n    forbidden(body?: any): void;\n    validationError(details: Record<string, any>): void;\n}\n//#endregion\n\nexport interface FunctionsService {\n    createHttRequest(...args: any[]): [HTTPRequest, HTTPAuth?];\n    createScheduleRequest(...args: any[]): [ScheduleRequest];\n    createEventRequest(...args: any[]): [EventRequest];\n    createWebSocketRequest(...args: any[]): [WebSocketRequest];\n    createInvokeRequest(...args: any[]): [InvokeRequest];\n\n    buildHttpResponse(httpFunctionContext: HttpFunctionContext, ...args: any[]): any\n    buildScheduleResponse(scheduleFunctionContext: ScheduleFunctionContext, ...args: any[]): any;\n    buildEventResponse(eventFunctionContext: EventFunctionContext, ...args: any[]): Promise<EventBatchItemResult>;\n    buildWebSocketResponse(webSocketFunctionContext: WebSocketFunctionContext, ...args: any[]): any;\n    buildInvokeResponse(invokeFunctionContext: InvokeFunctionContext, ...args: any[]): any;\n}"],"mappings":";AAuCO,IAAK,YAAL,kBAAKA,eAAL;AAEH,EAAAA,WAAA,sBAAmB;AACnB,EAAAA,WAAA,mBAAgB;AAGhB,EAAAA,WAAA,kBAAe;AACf,EAAAA,WAAA,mBAAgB;AAGhB,EAAAA,WAAA,wBAAqB;AACrB,EAAAA,WAAA,6BAA0B;AAC1B,EAAAA,WAAA,uBAAoB;AAGpB,EAAAA,WAAA,2BAAwB;AACxB,EAAAA,WAAA,yBAAsB;AACtB,EAAAA,WAAA,oBAAiB;AAGjB,EAAAA,WAAA,6BAA0B;AAG1B,EAAAA,WAAA,wBAAqB;AAGrB,EAAAA,WAAA,mBAAgB;AA1BR,SAAAA;AAAA,GAAA;","names":["ErrorCode"]}
+{"version":3,"sources":["../src/services/functions.ts","../src/services/websocket.ts"],"sourcesContent":["import { HandlerType, HttpMethod, WebSocketEvent } from \"../entrypoint\";\n\n/**\n * Represents the context object for a function handler.\n */\nexport type FunctionContext = {\n    /**\n     * The underlying context handler type.\n     */\n    type: HandlerType;\n\n    /**\n     * Creates a success response. This should be called when the handler is done successfully.\n     * @param data - The response body.\n     */\n    success<T>(data: T): void;\n\n    /**\n     * Creates a server error response. This should be called when the handler encounters an unexpected error.\n     * @param err - The error object.\n     */\n    serverError(err: Error): void;\n    /**\n     * Creates an error response. This should be called when the handler is done with an error.\n     * @param message - The response body.\n     * \n     */\n    error(message: string, code?: ErrorCode, details?: Record<string, any>, stack?: string): void;\n    /**\n     * Creates a not found response. This should be called when the requested resource is not found.\n     * @param resource - The name of the resource that was not found.\n     * @param id - The id of the resource that was not found (optional).\n     */\n    notFound(resource: string, id?: string | number): void;\n};\n\n/**\n * Error codes for API error responses\n */\nexport enum ErrorCode {\n    // Validation errors\n    VALIDATION_ERROR = 'VALIDATION_ERROR',\n    INVALID_INPUT = 'INVALID_INPUT',\n\n    // Authentication errors\n    UNAUTHORIZED = 'UNAUTHORIZED',\n    ACCESS_DENIED = 'ACCESS_DENIED',\n\n    // Resource errors\n    RESOURCE_NOT_FOUND = 'RESOURCE_NOT_FOUND',\n    RESOURCE_ALREADY_EXISTS = 'RESOURCE_ALREADY_EXISTS',\n    RESOURCE_CONFLICT = 'RESOURCE_CONFLICT',\n\n    // System errors\n    INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR',\n    SERVICE_UNAVAILABLE = 'SERVICE_UNAVAILABLE',\n    DATABASE_ERROR = 'DATABASE_ERROR',\n\n    // Business logic errors\n    BUSINESS_RULE_VIOLATION = 'BUSINESS_RULE_VIOLATION',\n\n    // External API errors\n    EXTERNAL_API_ERROR = 'EXTERNAL_API_ERROR',\n\n    // Other errors\n    UNKNOWN_ERROR = 'UNKNOWN_ERROR'\n}\n\n//#region [ Http ]\n\nexport type HTTPRequest = {\n    method: HttpMethod;\n    body?: string;\n    headers: Record<string, string | string[] | undefined>;\n    url: string;\n    params: Record<string, string | undefined>\n    matchingKey?: string;\n    rawQueryString?: string,\n    requestId?: string,\n    host?: string\n};\n\nexport type HTTPResponse = {\n    headers?: Record<string, string | string[] | undefined>;\n    body?: string;\n    status: number;\n};\n\nexport type HTTPAuth = {\n    token: string;\n    appId: string;\n    memberId: string;\n    customerId: string;\n    claims: Record<string, string>;\n    identity: \"facebook\" | \"google\" | \"apple\" | \"password\";\n};\n\nexport type HttpFunctionContext = FunctionContext & {\n    type: \"Http\";\n    request: HTTPRequest;\n    auth?: HTTPAuth;\n    response: HTTPResponse;\n    model<T = Record<string, any>>(): T;\n    params<T = Record<string, string>>(): T;\n\n    list<T>(items: T[], page: number, pageSize: number, totalItems: number): void;\n    cursorList<T>(items: T[], nextCursor: string | null, pageSize: number, prevCursor?: string | null): void;\n    created<T>(data: T): void;\n    deleted(id?: string | number): void;\n    validationError(details: Record<string, any>): void;\n    serverError(err: Error): void;\n    businessError(message: string, details?: Record<string, any>): void;\n\n    unauthorized(message?: string): void;\n    forbidden(message?: string): void;\n    output(status: number, body?: string | object, headers?: Record<string, string | string[]>): void;\n}\n\n//#endregion\n\n//#region [Schedule]\n\nexport type ScheduleResponse = {\n    status: \"success\" | \"error\",\n    body?: string | Record<string, any>;\n}\n\nexport type ScheduleRequest = {\n    name: string,\n    requestId?: string\n};\n\nexport type ScheduleFunctionContext = FunctionContext & {\n    response: ScheduleResponse;\n    request: ScheduleRequest;\n    type: \"Schedule\";\n}\n//#endregion\n\n//#region [Event]\nexport type EventRequest = {\n    body: string | Record<string, any>,\n    attributes: Record<string, string>,\n    requestId?: string,\n    timestamp: Date,\n    attempts?: number;\n}\n\nexport type EventResponse = {\n    status: \"success\" | \"error\",\n    code?: ErrorCode,\n    body?: Record<string, any>\n    stack?: string,\n    retryDelay?: number,\n};\n\nexport type EventFunctionContext = FunctionContext & {\n    type: \"Event\";\n    timestamp: Date;\n    attempts?: number;\n    request: EventRequest;\n    response: EventResponse;\n    message<T = Record<string, any>>(): T;\n    attributes<T = Record<string, any>>(): T;\n    retryWithDelay(seconds: number): void;\n}\n\nexport type EventBatchItemResult = { failureId: string } | undefined;\n//#endregion\n\n//#region [Invoke]\nexport type InvokeRequest = {\n    payload: any,\n    calledModule: string,\n    invokeTriggerName: string,\n    requestId?: string,\n}\n\nexport type InvokeResponse = {\n    status: \"success\" | \"error\",\n    body?: any,\n    code?: ErrorCode,\n}\n\nexport type InvokeFunctionContext = FunctionContext & {\n    type: \"Invoke\";\n    request: InvokeRequest;\n    response: InvokeResponse;\n    payload<T = Record<string, any>>(): T;\n}\n//#endregion\n\n//#region [WebSocket]\nexport type WebSocketRequest = {\n    connectionId: string,\n    event: WebSocketEvent,\n    route?: string,\n    url?: string,\n    params: Record<string, string | undefined> | null,\n    body?: string | Record<string, any> | null,\n    headers?: Record<string, string | string[] | undefined>,\n    queryString: Record<string, string | undefined> | null,\n    requestId?: string,\n}\n\nexport type WebSocketResponse = {\n    status: \"success\" | \"error\",\n    statusCode?: number,\n    body?: any,\n}\n\nexport type WebSocketFunctionContext = FunctionContext & {\n    type: \"WebSocket\";\n    connectionId: string;\n    event: WebSocketEvent;\n    request: WebSocketRequest;\n    response: WebSocketResponse;\n    message<T = Record<string, any>>(): T;\n    params<T = Record<string, string>>(): T;\n    unauthorized(body?: any): void;\n    forbidden(body?: any): void;\n    validationError(details: Record<string, any>): void;\n}\n//#endregion\n\nexport interface FunctionsService {\n    createHttRequest(...args: any[]): [HTTPRequest, HTTPAuth?];\n    createScheduleRequest(...args: any[]): [ScheduleRequest];\n    createEventRequest(...args: any[]): [EventRequest];\n    createWebSocketRequest(...args: any[]): [WebSocketRequest];\n    createInvokeRequest(...args: any[]): [InvokeRequest];\n\n    buildHttpResponse(httpFunctionContext: HttpFunctionContext, ...args: any[]): any\n    buildScheduleResponse(scheduleFunctionContext: ScheduleFunctionContext, ...args: any[]): any;\n    buildEventResponse(eventFunctionContext: EventFunctionContext, ...args: any[]): Promise<EventBatchItemResult>;\n    buildWebSocketResponse(webSocketFunctionContext: WebSocketFunctionContext, ...args: any[]): any;\n    buildInvokeResponse(invokeFunctionContext: InvokeFunctionContext, ...args: any[]): any;\n}","/**\n * Thrown when a sendToClient/disconnect is attempted against a connectionId\n * that is no longer connected (AWS API Gateway GoneException equivalent, HTTP 410).\n */\nexport class WebSocketConnectionGoneError extends Error {\n    public readonly connectionId: string;\n\n    constructor(connectionId: string) {\n        super(`WebSocket connection ${connectionId} is gone`);\n        this.name = \"WebSocketConnectionGoneError\";\n        this.connectionId = connectionId;\n    }\n}\n\nexport interface WebSocketService {\n    /**\n     * Send a message to a specific connected client\n     * @param connectionId The connection ID of the target client\n     * @param data The data to send\n     */\n    sendToClient(connectionId: string, data: any): Promise<void>;\n\n    /**\n     * Disconnect a specific connected client\n     * @param connectionId The connection ID of the client to disconnect\n     */\n    disconnect(connectionId: string): Promise<void>;\n}\n"],"mappings":";AAuCO,IAAK,YAAL,kBAAKA,eAAL;AAEH,EAAAA,WAAA,sBAAmB;AACnB,EAAAA,WAAA,mBAAgB;AAGhB,EAAAA,WAAA,kBAAe;AACf,EAAAA,WAAA,mBAAgB;AAGhB,EAAAA,WAAA,wBAAqB;AACrB,EAAAA,WAAA,6BAA0B;AAC1B,EAAAA,WAAA,uBAAoB;AAGpB,EAAAA,WAAA,2BAAwB;AACxB,EAAAA,WAAA,yBAAsB;AACtB,EAAAA,WAAA,oBAAiB;AAGjB,EAAAA,WAAA,6BAA0B;AAG1B,EAAAA,WAAA,wBAAqB;AAGrB,EAAAA,WAAA,mBAAgB;AA1BR,SAAAA;AAAA,GAAA;;;ACnCL,IAAM,+BAAN,cAA2C,MAAM;AAAA,EACpC;AAAA,EAEhB,YAAY,cAAsB;AAC9B,UAAM,wBAAwB,YAAY,UAAU;AACpD,SAAK,OAAO;AACZ,SAAK,eAAe;AAAA,EACxB;AACJ;","names":["ErrorCode"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudnux/core-cloud-provider",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "CloudNux core interfaces and types for multi-cloud abstraction",
   "license": "MIT",
   "type": "module",