@cloudnux/core-cloud-provider 0.5.0 → 0.11.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-type HandlerType = "Http" | "Schedule" | "Event";
+type HandlerType = "Http" | "Schedule" | "Event" | "WebSocket";
 type BaseEntry<TTrigger> = {
     handler: string;
     trigger: TTrigger;
@@ -69,7 +69,19 @@ type EventTrigger = {
 };
 type EventEntry = BaseEntry<EventTrigger>;
 
-type Entry = HttpEntry | ScheduleEntry | EventEntry;
+type WebSocketEvent = "connect" | "disconnect" | "message";
+type WebSocketTrigger = {
+    type: "websocket";
+    options: {
+        path: string;
+        event: WebSocketEvent;
+        route?: string;
+        routeKey?: string;
+    };
+};
+type WebSocketEntry = BaseEntry<WebSocketTrigger>;
+
+type Entry = HttpEntry | ScheduleEntry | EventEntry | WebSocketEntry;
 type Entrypoint = {
     entries: Record<string, Entry>;
 };
@@ -392,13 +404,46 @@ type EventFunctionContext = FunctionContext & {
     message<T = Record<string, any>>(): T;
     attributes<T = Record<string, any>>(): T;
 };
+type WebSocketRequest = {
+    connectionId: string;
+    event: WebSocketEvent;
+    path: string;
+    route?: string;
+    body?: string | Record<string, any>;
+    headers?: Record<string, string | string[] | undefined>;
+    query?: Record<string, string>;
+    requestId?: string;
+};
+type WebSocketResponse = {
+    status: "success" | "error";
+    body?: any;
+};
+type WebSocketFunctionContext = FunctionContext & {
+    type: "WebSocket";
+    connectionId: string;
+    event: WebSocketEvent;
+    request: WebSocketRequest;
+    response: WebSocketResponse;
+    message<T = Record<string, any>>(): T;
+};
 interface FunctionsService {
     createHttRequest(...args: any[]): [HTTPRequest, HTTPAuth?];
     createScheduleRequest(...args: any[]): [ScheduleRequest];
     createEventRequest(...args: any[]): [EventRequest];
+    createWebSocketRequest(...args: any[]): [WebSocketRequest];
     buildHttpResponse(httpFunctionContext: HttpFunctionContext, ...args: any[]): any;
     buildScheduleResponse(scheduleFunctionContext: ScheduleFunctionContext, ...args: any[]): any;
     buildEventResponse(eventFunctionContext: EventFunctionContext, ...args: any[]): any;
+    buildWebSocketResponse(webSocketFunctionContext: WebSocketFunctionContext, ...args: any[]): any;
+}
+
+interface WebSocketService {
+    /**
+     * Send a message to a specific connected client
+     * @param connectionId The connection ID of the target client
+     * @param data The data to send
+     */
+    sendToClient(connectionId: string, data: any): Promise<void>;
 }
 
 interface CloudProvider {
@@ -407,6 +452,7 @@ interface CloudProvider {
     createLocationService(): LocationService;
     createEventBrokerService(): EventBrokerService;
     createFunctionsService(): FunctionsService;
+    createWebSocketService(): WebSocketService;
 }
 
-export { type BaseEntry, type CloudProvider, type Coordinates, type Entry, type Entrypoint, ErrorCode, 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 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 };
+export { type BaseEntry, type CloudProvider, type Coordinates, type Entry, type Entrypoint, ErrorCode, 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 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 };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/services/functions.ts"],"sourcesContent":["import { HandlerType, HttpMethod } 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 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    notFound(resource: string, id?: string | number): void;\n\n\n\n    // success(body?: any): void;\n\n\n    // error(body?: any): void;\n\n    // /**\n    //  * Creates a not found response. This should be called when there is no matching handler.\n    //  * @param body - The response body.\n    //  * @returns A promise that resolves when the response is created, or void if not using a promise.\n    //  */\n    // notFound(body?: any): 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    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    output(status: number, body?: string, 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};\n\nexport type EventFunctionContext = FunctionContext & {\n    type: \"Event\";\n    timestamp: Date;\n    attempts?: number;\n    response: EventResponse;\n    message<T = Record<string, any>>(): T;\n    attributes<T = Record<string, any>>(): T;\n}\n//#endregion\n\nexport interface FunctionsService {\n    createHttRequest(...args: any[]): [HTTPRequest, HTTPAuth?];\n    createScheduleRequest(...args: any[]): [ScheduleRequest];\n    createEventRequest(...args: any[]): [EventRequest];\n\n    buildHttpResponse(httpFunctionContext: HttpFunctionContext, ...args: any[]): any\n    buildScheduleResponse(scheduleFunctionContext: ScheduleFunctionContext, ...args: any[]): any;\n    buildEventResponse(eventFunctionContext: EventFunctionContext, ...args: any[]): any;\n}"],"mappings":";AA2CO,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"],"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 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    notFound(resource: string, id?: string | number): void;\n\n\n\n    // success(body?: any): void;\n\n\n    // error(body?: any): void;\n\n    // /**\n    //  * Creates a not found response. This should be called when there is no matching handler.\n    //  * @param body - The response body.\n    //  * @returns A promise that resolves when the response is created, or void if not using a promise.\n    //  */\n    // notFound(body?: any): 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    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    output(status: number, body?: string, 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};\n\nexport type EventFunctionContext = FunctionContext & {\n    type: \"Event\";\n    timestamp: Date;\n    attempts?: number;\n    response: EventResponse;\n    message<T = Record<string, any>>(): T;\n    attributes<T = Record<string, any>>(): T;\n}\n//#endregion\n\n//#region [WebSocket]\nexport type WebSocketRequest = {\n    connectionId: string,\n    event: WebSocketEvent,\n    path: string,\n    route?: string,\n    body?: string | Record<string, any>,\n    headers?: Record<string, string | string[] | undefined>,\n    query?: Record<string, string>,\n    requestId?: string,\n}\n\nexport type WebSocketResponse = {\n    status: \"success\" | \"error\",\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}\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\n    buildHttpResponse(httpFunctionContext: HttpFunctionContext, ...args: any[]): any\n    buildScheduleResponse(scheduleFunctionContext: ScheduleFunctionContext, ...args: any[]): any;\n    buildEventResponse(eventFunctionContext: EventFunctionContext, ...args: any[]): any;\n    buildWebSocketResponse(webSocketFunctionContext: WebSocketFunctionContext, ...args: any[]): any;\n}"],"mappings":";AA2CO,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"]}

package/package.json

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