@venturekit/runtime 0.0.0-dev.20260307234057
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +191 -0
- package/dist/context.d.ts +86 -0
- package/dist/context.js +76 -0
- package/dist/errors.d.ts +80 -0
- package/dist/errors.js +134 -0
- package/dist/handler.d.ts +71 -0
- package/dist/handler.js +176 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.js +53 -0
- package/dist/logger.d.ts +72 -0
- package/dist/logger.js +105 -0
- package/dist/middleware.d.ts +46 -0
- package/dist/middleware.js +147 -0
- package/dist/response.d.ts +75 -0
- package/dist/response.js +107 -0
- package/dist/ws.d.ts +138 -0
- package/dist/ws.js +277 -0
- package/package.json +61 -0
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* VentureKit Middleware
|
|
4
|
+
*
|
|
5
|
+
* Composable middleware for request processing.
|
|
6
|
+
* Extensible for auth, tenancy, rate limiting, etc.
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.compose = compose;
|
|
10
|
+
exports.loggingMiddleware = loggingMiddleware;
|
|
11
|
+
exports.corsMiddleware = corsMiddleware;
|
|
12
|
+
exports.timeoutMiddleware = timeoutMiddleware;
|
|
13
|
+
exports.errorBoundaryMiddleware = errorBoundaryMiddleware;
|
|
14
|
+
/**
|
|
15
|
+
* Compose multiple middleware into a single function
|
|
16
|
+
*/
|
|
17
|
+
function compose(middlewares) {
|
|
18
|
+
return async (ctx, finalHandler) => {
|
|
19
|
+
let index = -1;
|
|
20
|
+
const dispatch = async (i) => {
|
|
21
|
+
if (i <= index) {
|
|
22
|
+
throw new Error('next() called multiple times');
|
|
23
|
+
}
|
|
24
|
+
index = i;
|
|
25
|
+
if (i >= middlewares.length) {
|
|
26
|
+
return finalHandler();
|
|
27
|
+
}
|
|
28
|
+
const middleware = middlewares[i];
|
|
29
|
+
return middleware.fn(ctx, () => dispatch(i + 1));
|
|
30
|
+
};
|
|
31
|
+
return dispatch(0);
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Logging middleware - logs request/response
|
|
36
|
+
*/
|
|
37
|
+
function loggingMiddleware(logger) {
|
|
38
|
+
return {
|
|
39
|
+
name: 'logging',
|
|
40
|
+
fn: async (ctx, next) => {
|
|
41
|
+
const start = Date.now();
|
|
42
|
+
logger.info('Request started', {
|
|
43
|
+
method: ctx.method,
|
|
44
|
+
path: ctx.path,
|
|
45
|
+
sourceIp: ctx.sourceIp,
|
|
46
|
+
});
|
|
47
|
+
try {
|
|
48
|
+
const response = await next();
|
|
49
|
+
const duration = Date.now() - start;
|
|
50
|
+
logger.info('Request completed', {
|
|
51
|
+
method: ctx.method,
|
|
52
|
+
path: ctx.path,
|
|
53
|
+
statusCode: typeof response === 'object' ? response.statusCode : undefined,
|
|
54
|
+
duration,
|
|
55
|
+
});
|
|
56
|
+
return response;
|
|
57
|
+
}
|
|
58
|
+
catch (error) {
|
|
59
|
+
const duration = Date.now() - start;
|
|
60
|
+
logger.error('Request failed', {
|
|
61
|
+
method: ctx.method,
|
|
62
|
+
path: ctx.path,
|
|
63
|
+
duration,
|
|
64
|
+
error: error instanceof Error ? error.message : 'Unknown error',
|
|
65
|
+
});
|
|
66
|
+
throw error;
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* CORS middleware - adds CORS headers
|
|
73
|
+
*/
|
|
74
|
+
function corsMiddleware(options) {
|
|
75
|
+
return {
|
|
76
|
+
name: 'cors',
|
|
77
|
+
fn: async (ctx, next) => {
|
|
78
|
+
const origin = ctx.rawEvent.headers?.origin || '';
|
|
79
|
+
const allowedOrigin = options.allowOrigins.includes('*')
|
|
80
|
+
? '*'
|
|
81
|
+
: options.allowOrigins.includes(origin)
|
|
82
|
+
? origin
|
|
83
|
+
: '';
|
|
84
|
+
// Handle preflight
|
|
85
|
+
if (ctx.method === 'OPTIONS') {
|
|
86
|
+
return {
|
|
87
|
+
statusCode: 204,
|
|
88
|
+
headers: {
|
|
89
|
+
'Access-Control-Allow-Origin': allowedOrigin,
|
|
90
|
+
'Access-Control-Allow-Methods': options.allowMethods.join(', '),
|
|
91
|
+
'Access-Control-Allow-Headers': options.allowHeaders.join(', '),
|
|
92
|
+
'Access-Control-Allow-Credentials': String(options.allowCredentials),
|
|
93
|
+
'Access-Control-Max-Age': String(options.maxAge),
|
|
94
|
+
},
|
|
95
|
+
body: '',
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
const response = await next();
|
|
99
|
+
// Add CORS headers to response
|
|
100
|
+
if (typeof response !== 'object' || response === null) {
|
|
101
|
+
return response;
|
|
102
|
+
}
|
|
103
|
+
const resp = response;
|
|
104
|
+
const corsHeaders = {
|
|
105
|
+
'Access-Control-Allow-Origin': allowedOrigin,
|
|
106
|
+
};
|
|
107
|
+
if (options.allowCredentials) {
|
|
108
|
+
corsHeaders['Access-Control-Allow-Credentials'] = 'true';
|
|
109
|
+
}
|
|
110
|
+
resp.headers = { ...resp.headers, ...corsHeaders };
|
|
111
|
+
return resp;
|
|
112
|
+
},
|
|
113
|
+
};
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Timeout middleware - enforces request timeout
|
|
117
|
+
*/
|
|
118
|
+
function timeoutMiddleware(timeoutMs) {
|
|
119
|
+
return {
|
|
120
|
+
name: 'timeout',
|
|
121
|
+
fn: async (ctx, next) => {
|
|
122
|
+
const timeoutPromise = new Promise((_, reject) => {
|
|
123
|
+
setTimeout(() => {
|
|
124
|
+
reject(new Error(`Request timeout after ${timeoutMs}ms`));
|
|
125
|
+
}, timeoutMs);
|
|
126
|
+
});
|
|
127
|
+
return Promise.race([next(), timeoutPromise]);
|
|
128
|
+
},
|
|
129
|
+
};
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Error boundary middleware - catches and formats errors
|
|
133
|
+
*/
|
|
134
|
+
function errorBoundaryMiddleware(errorHandler) {
|
|
135
|
+
return {
|
|
136
|
+
name: 'errorBoundary',
|
|
137
|
+
fn: async (ctx, next) => {
|
|
138
|
+
try {
|
|
139
|
+
return await next();
|
|
140
|
+
}
|
|
141
|
+
catch (error) {
|
|
142
|
+
return errorHandler(error, ctx);
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
};
|
|
146
|
+
}
|
|
147
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAyBH,0BAoBC;AAKD,8CAsCC;AAKD,wCAiDC;AAKD,8CAaC;AAKD,0DAaC;AA5JD;;GAEG;AACH,SAAgB,OAAO,CAAC,WAAyB;IAC/C,OAAO,KAAK,EAAE,GAAmB,EAAE,YAAoD,EAAE,EAAE;QACzF,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;QAEf,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAS,EAAoC,EAAE;YACrE,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,KAAK,GAAG,CAAC,CAAC;YAEV,IAAI,CAAC,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;gBAC5B,OAAO,YAAY,EAAE,CAAC;YACxB,CAAC;YAED,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAClC,OAAO,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,MAAc;IAC9C,OAAO;QACL,IAAI,EAAE,SAAS;QACf,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEzB,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBAC7B,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB,CAAC,CAAC;YAEH,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;gBAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;gBAEpC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE;oBAC/B,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,UAAU,EAAE,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAE,QAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;oBACnF,QAAQ;iBACT,CAAC,CAAC;gBAEH,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;gBAEpC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;oBAC7B,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,QAAQ;oBACR,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;iBAChE,CAAC,CAAC;gBAEH,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,OAM9B;IACC,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACtB,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC;YAClD,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACtD,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC;oBACrC,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,EAAE,CAAC;YAET,mBAAmB;YACnB,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC7B,OAAO;oBACL,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,6BAA6B,EAAE,aAAa;wBAC5C,8BAA8B,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;wBAC/D,8BAA8B,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;wBAC/D,kCAAkC,EAAE,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC;wBACpE,wBAAwB,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;qBACjD;oBACD,IAAI,EAAE,EAAE;iBACT,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;YAE9B,+BAA+B;YAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACtD,OAAO,QAAQ,CAAC;YAClB,CAAC;YACD,MAAM,IAAI,GAAG,QAA6C,CAAC;YAC3D,MAAM,WAAW,GAA2B;gBAC1C,6BAA6B,EAAE,aAAa;aAC7C,CAAC;YACF,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC7B,WAAW,CAAC,kCAAkC,CAAC,GAAG,MAAM,CAAC;YAC3D,CAAC;YACD,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,WAAW,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,SAAiB;IACjD,OAAO;QACL,IAAI,EAAE,SAAS;QACf,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACtB,MAAM,cAAc,GAAG,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;gBACtD,UAAU,CAAC,GAAG,EAAE;oBACd,MAAM,CAAC,IAAI,KAAK,CAAC,yBAAyB,SAAS,IAAI,CAAC,CAAC,CAAC;gBAC5D,CAAC,EAAE,SAAS,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;QAChD,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,uBAAuB,CACrC,YAA8E;IAE9E,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACtB,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,EAAE,CAAC;YACtB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/**\n * VentureKit Middleware\n * \n * Composable middleware for request processing.\n * Extensible for auth, tenancy, rate limiting, etc.\n */\n\nimport type { APIGatewayProxyEventV2, APIGatewayProxyResultV2, APIGatewayProxyStructuredResultV2 } from 'aws-lambda';\nimport { RequestContext } from './context';\nimport { Logger } from './logger';\n\n/**\n * Middleware function signature\n */\nexport type MiddlewareFn = (\n  ctx: RequestContext,\n  next: () => Promise<APIGatewayProxyResultV2>\n) => Promise<APIGatewayProxyResultV2>;\n\n/**\n * Middleware with configuration\n */\nexport interface Middleware {\n  name: string;\n  fn: MiddlewareFn;\n}\n\n/**\n * Compose multiple middleware into a single function\n */\nexport function compose(middlewares: Middleware[]): MiddlewareFn {\n  return async (ctx: RequestContext, finalHandler: () => Promise<APIGatewayProxyResultV2>) => {\n    let index = -1;\n\n    const dispatch = async (i: number): Promise<APIGatewayProxyResultV2> => {\n      if (i <= index) {\n        throw new Error('next() called multiple times');\n      }\n      index = i;\n\n      if (i >= middlewares.length) {\n        return finalHandler();\n      }\n\n      const middleware = middlewares[i];\n      return middleware.fn(ctx, () => dispatch(i + 1));\n    };\n\n    return dispatch(0);\n  };\n}\n\n/**\n * Logging middleware - logs request/response\n */\nexport function loggingMiddleware(logger: Logger): Middleware {\n  return {\n    name: 'logging',\n    fn: async (ctx, next) => {\n      const start = Date.now();\n      \n      logger.info('Request started', {\n        method: ctx.method,\n        path: ctx.path,\n        sourceIp: ctx.sourceIp,\n      });\n\n      try {\n        const response = await next();\n        const duration = Date.now() - start;\n\n        logger.info('Request completed', {\n          method: ctx.method,\n          path: ctx.path,\n          statusCode: typeof response === 'object' ? (response as any).statusCode : undefined,\n          duration,\n        });\n\n        return response;\n      } catch (error) {\n        const duration = Date.now() - start;\n\n        logger.error('Request failed', {\n          method: ctx.method,\n          path: ctx.path,\n          duration,\n          error: error instanceof Error ? error.message : 'Unknown error',\n        });\n\n        throw error;\n      }\n    },\n  };\n}\n\n/**\n * CORS middleware - adds CORS headers\n */\nexport function corsMiddleware(options: {\n  allowOrigins: string[];\n  allowMethods: string[];\n  allowHeaders: string[];\n  allowCredentials: boolean;\n  maxAge: number;\n}): Middleware {\n  return {\n    name: 'cors',\n    fn: async (ctx, next) => {\n      const origin = ctx.rawEvent.headers?.origin || '';\n      const allowedOrigin = options.allowOrigins.includes('*')\n        ? '*'\n        : options.allowOrigins.includes(origin)\n          ? origin\n          : '';\n\n      // Handle preflight\n      if (ctx.method === 'OPTIONS') {\n        return {\n          statusCode: 204,\n          headers: {\n            'Access-Control-Allow-Origin': allowedOrigin,\n            'Access-Control-Allow-Methods': options.allowMethods.join(', '),\n            'Access-Control-Allow-Headers': options.allowHeaders.join(', '),\n            'Access-Control-Allow-Credentials': String(options.allowCredentials),\n            'Access-Control-Max-Age': String(options.maxAge),\n          },\n          body: '',\n        };\n      }\n\n      const response = await next();\n\n      // Add CORS headers to response\n      if (typeof response !== 'object' || response === null) {\n        return response;\n      }\n      const resp = response as APIGatewayProxyStructuredResultV2;\n      const corsHeaders: Record<string, string> = {\n        'Access-Control-Allow-Origin': allowedOrigin,\n      };\n      if (options.allowCredentials) {\n        corsHeaders['Access-Control-Allow-Credentials'] = 'true';\n      }\n      resp.headers = { ...resp.headers, ...corsHeaders };\n      return resp;\n    },\n  };\n}\n\n/**\n * Timeout middleware - enforces request timeout\n */\nexport function timeoutMiddleware(timeoutMs: number): Middleware {\n  return {\n    name: 'timeout',\n    fn: async (ctx, next) => {\n      const timeoutPromise = new Promise<never>((_, reject) => {\n        setTimeout(() => {\n          reject(new Error(`Request timeout after ${timeoutMs}ms`));\n        }, timeoutMs);\n      });\n\n      return Promise.race([next(), timeoutPromise]);\n    },\n  };\n}\n\n/**\n * Error boundary middleware - catches and formats errors\n */\nexport function errorBoundaryMiddleware(\n  errorHandler: (error: unknown, ctx: RequestContext) => APIGatewayProxyResultV2\n): Middleware {\n  return {\n    name: 'errorBoundary',\n    fn: async (ctx, next) => {\n      try {\n        return await next();\n      } catch (error) {\n        return errorHandler(error, ctx);\n      }\n    },\n  };\n}\n"]}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* VentureKit Response Utilities
|
|
3
|
+
*
|
|
4
|
+
* Standardized response formatting for API Gateway.
|
|
5
|
+
*/
|
|
6
|
+
import type { APIGatewayProxyResultV2 } from 'aws-lambda';
|
|
7
|
+
import { VentureError } from './errors';
|
|
8
|
+
/**
|
|
9
|
+
* Standard success response
|
|
10
|
+
*/
|
|
11
|
+
export interface SuccessResponse<T = unknown> {
|
|
12
|
+
data: T;
|
|
13
|
+
meta?: {
|
|
14
|
+
requestId?: string;
|
|
15
|
+
timestamp?: string;
|
|
16
|
+
pagination?: {
|
|
17
|
+
page: number;
|
|
18
|
+
pageSize: number;
|
|
19
|
+
total: number;
|
|
20
|
+
totalPages: number;
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Standard error response
|
|
26
|
+
*/
|
|
27
|
+
export interface ErrorResponse {
|
|
28
|
+
error: {
|
|
29
|
+
code: string;
|
|
30
|
+
message: string;
|
|
31
|
+
details?: Record<string, unknown>;
|
|
32
|
+
};
|
|
33
|
+
meta?: {
|
|
34
|
+
requestId?: string;
|
|
35
|
+
timestamp?: string;
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Create a success response
|
|
40
|
+
*/
|
|
41
|
+
export declare function success<T>(data: T, options?: {
|
|
42
|
+
statusCode?: number;
|
|
43
|
+
headers?: Record<string, string>;
|
|
44
|
+
requestId?: string;
|
|
45
|
+
}): APIGatewayProxyResultV2;
|
|
46
|
+
/**
|
|
47
|
+
* Create a created response (201)
|
|
48
|
+
*/
|
|
49
|
+
export declare function created<T>(data: T, options?: {
|
|
50
|
+
headers?: Record<string, string>;
|
|
51
|
+
requestId?: string;
|
|
52
|
+
}): APIGatewayProxyResultV2;
|
|
53
|
+
/**
|
|
54
|
+
* Create a no content response (204)
|
|
55
|
+
*/
|
|
56
|
+
export declare function noContent(options?: {
|
|
57
|
+
requestId?: string;
|
|
58
|
+
}): APIGatewayProxyResultV2;
|
|
59
|
+
/**
|
|
60
|
+
* Create an error response from a VentureError
|
|
61
|
+
*/
|
|
62
|
+
export declare function error(err: VentureError, options?: {
|
|
63
|
+
requestId?: string;
|
|
64
|
+
}): APIGatewayProxyResultV2;
|
|
65
|
+
/**
|
|
66
|
+
* Convert any error to an API Gateway response
|
|
67
|
+
*/
|
|
68
|
+
export declare function errorResponse(err: unknown, options?: {
|
|
69
|
+
requestId?: string;
|
|
70
|
+
logError?: boolean;
|
|
71
|
+
}): APIGatewayProxyResultV2;
|
|
72
|
+
/**
|
|
73
|
+
* Create a redirect response
|
|
74
|
+
*/
|
|
75
|
+
export declare function redirect(location: string, permanent?: boolean): APIGatewayProxyResultV2;
|
package/dist/response.js
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* VentureKit Response Utilities
|
|
4
|
+
*
|
|
5
|
+
* Standardized response formatting for API Gateway.
|
|
6
|
+
*/
|
|
7
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
|
+
exports.success = success;
|
|
9
|
+
exports.created = created;
|
|
10
|
+
exports.noContent = noContent;
|
|
11
|
+
exports.error = error;
|
|
12
|
+
exports.errorResponse = errorResponse;
|
|
13
|
+
exports.redirect = redirect;
|
|
14
|
+
const errors_1 = require("./errors");
|
|
15
|
+
/**
|
|
16
|
+
* Create a success response
|
|
17
|
+
*/
|
|
18
|
+
function success(data, options = {}) {
|
|
19
|
+
const { statusCode = 200, headers = {}, requestId } = options;
|
|
20
|
+
const body = {
|
|
21
|
+
data,
|
|
22
|
+
...(requestId && {
|
|
23
|
+
meta: {
|
|
24
|
+
requestId,
|
|
25
|
+
timestamp: new Date().toISOString(),
|
|
26
|
+
},
|
|
27
|
+
}),
|
|
28
|
+
};
|
|
29
|
+
return {
|
|
30
|
+
statusCode,
|
|
31
|
+
headers: {
|
|
32
|
+
'Content-Type': 'application/json',
|
|
33
|
+
...headers,
|
|
34
|
+
},
|
|
35
|
+
body: JSON.stringify(body),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Create a created response (201)
|
|
40
|
+
*/
|
|
41
|
+
function created(data, options = {}) {
|
|
42
|
+
return success(data, { ...options, statusCode: 201 });
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Create a no content response (204)
|
|
46
|
+
*/
|
|
47
|
+
function noContent(options = {}) {
|
|
48
|
+
return {
|
|
49
|
+
statusCode: 204,
|
|
50
|
+
body: '',
|
|
51
|
+
headers: options.requestId ? { 'x-request-id': options.requestId } : undefined,
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Create an error response from a VentureError
|
|
56
|
+
*/
|
|
57
|
+
function error(err, options = {}) {
|
|
58
|
+
const { requestId } = options;
|
|
59
|
+
const body = {
|
|
60
|
+
error: {
|
|
61
|
+
code: err.code,
|
|
62
|
+
message: err.message,
|
|
63
|
+
...(err.details && { details: err.details }),
|
|
64
|
+
},
|
|
65
|
+
...(requestId && {
|
|
66
|
+
meta: {
|
|
67
|
+
requestId,
|
|
68
|
+
timestamp: new Date().toISOString(),
|
|
69
|
+
},
|
|
70
|
+
}),
|
|
71
|
+
};
|
|
72
|
+
return {
|
|
73
|
+
statusCode: err.statusCode,
|
|
74
|
+
headers: {
|
|
75
|
+
'Content-Type': 'application/json',
|
|
76
|
+
},
|
|
77
|
+
body: JSON.stringify(body),
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Convert any error to an API Gateway response
|
|
82
|
+
*/
|
|
83
|
+
function errorResponse(err, options = {}) {
|
|
84
|
+
const { requestId, logError = true } = options;
|
|
85
|
+
if ((0, errors_1.isVentureError)(err)) {
|
|
86
|
+
return error(err, { requestId });
|
|
87
|
+
}
|
|
88
|
+
// Log unexpected errors
|
|
89
|
+
if (logError) {
|
|
90
|
+
console.error('Unexpected error:', err);
|
|
91
|
+
}
|
|
92
|
+
// Wrap in InternalError for consistent response
|
|
93
|
+
return error(new errors_1.InternalError(), { requestId });
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Create a redirect response
|
|
97
|
+
*/
|
|
98
|
+
function redirect(location, permanent = false) {
|
|
99
|
+
return {
|
|
100
|
+
statusCode: permanent ? 301 : 302,
|
|
101
|
+
headers: {
|
|
102
|
+
Location: location,
|
|
103
|
+
},
|
|
104
|
+
body: '',
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVzcG9uc2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcmVzcG9uc2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7O0dBSUc7O0FBd0NILDBCQTRCQztBQUtELDBCQUtDO0FBS0QsOEJBTUM7QUFLRCxzQkEyQkM7QUFLRCxzQ0FpQkM7QUFLRCw0QkFXQztBQTVKRCxxQ0FBdUU7QUFrQ3ZFOztHQUVHO0FBQ0gsU0FBZ0IsT0FBTyxDQUNyQixJQUFPLEVBQ1AsVUFJSSxFQUFFO0lBRU4sTUFBTSxFQUFFLFVBQVUsR0FBRyxHQUFHLEVBQUUsT0FBTyxHQUFHLEVBQUUsRUFBRSxTQUFTLEVBQUUsR0FBRyxPQUFPLENBQUM7SUFFOUQsTUFBTSxJQUFJLEdBQXVCO1FBQy9CLElBQUk7UUFDSixHQUFHLENBQUMsU0FBUyxJQUFJO1lBQ2YsSUFBSSxFQUFFO2dCQUNKLFNBQVM7Z0JBQ1QsU0FBUyxFQUFFLElBQUksSUFBSSxFQUFFLENBQUMsV0FBVyxFQUFFO2FBQ3BDO1NBQ0YsQ0FBQztLQUNILENBQUM7SUFFRixPQUFPO1FBQ0wsVUFBVTtRQUNWLE9BQU8sRUFBRTtZQUNQLGNBQWMsRUFBRSxrQkFBa0I7WUFDbEMsR0FBRyxPQUFPO1NBQ1g7UUFDRCxJQUFJLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUM7S0FDM0IsQ0FBQztBQUNKLENBQUM7QUFFRDs7R0FFRztBQUNILFNBQWdCLE9BQU8sQ0FDckIsSUFBTyxFQUNQLFVBQW9FLEVBQUU7SUFFdEUsT0FBTyxPQUFPLENBQUMsSUFBSSxFQUFFLEVBQUUsR0FBRyxPQUFPLEVBQUUsVUFBVSxFQUFFLEdBQUcsRUFBRSxDQUFDLENBQUM7QUFDeEQsQ0FBQztBQUVEOztHQUVHO0FBQ0gsU0FBZ0IsU0FBUyxDQUFDLFVBQWtDLEVBQUU7SUFDNUQsT0FBTztRQUNMLFVBQVUsRUFBRSxHQUFHO1FBQ2YsSUFBSSxFQUFFLEVBQUU7UUFDUixPQUFPLEVBQUUsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRSxjQUFjLEVBQUUsT0FBTyxDQUFDLFNBQVMsRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTO0tBQy9FLENBQUM7QUFDSixDQUFDO0FBRUQ7O0dBRUc7QUFDSCxTQUFnQixLQUFLLENBQ25CLEdBQWlCLEVBQ2pCLFVBQWtDLEVBQUU7SUFFcEMsTUFBTSxFQUFFLFNBQVMsRUFBRSxHQUFHLE9BQU8sQ0FBQztJQUU5QixNQUFNLElBQUksR0FBa0I7UUFDMUIsS0FBSyxFQUFFO1lBQ0wsSUFBSSxFQUFFLEdBQUcsQ0FBQyxJQUFJO1lBQ2QsT0FBTyxFQUFFLEdBQUcsQ0FBQyxPQUFPO1lBQ3BCLEdBQUcsQ0FBQyxHQUFHLENBQUMsT0FBTyxJQUFJLEVBQUUsT0FBTyxFQUFFLEdBQUcsQ0FBQyxPQUFPLEVBQUUsQ0FBQztTQUM3QztRQUNELEdBQUcsQ0FBQyxTQUFTLElBQUk7WUFDZixJQUFJLEVBQUU7Z0JBQ0osU0FBUztnQkFDVCxTQUFTLEVBQUUsSUFBSSxJQUFJLEVBQUUsQ0FBQyxXQUFXLEVBQUU7YUFDcEM7U0FDRixDQUFDO0tBQ0gsQ0FBQztJQUVGLE9BQU87UUFDTCxVQUFVLEVBQUUsR0FBRyxDQUFDLFVBQVU7UUFDMUIsT0FBTyxFQUFFO1lBQ1AsY0FBYyxFQUFFLGtCQUFrQjtTQUNuQztRQUNELElBQUksRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQztLQUMzQixDQUFDO0FBQ0osQ0FBQztBQUVEOztHQUVHO0FBQ0gsU0FBZ0IsYUFBYSxDQUMzQixHQUFZLEVBQ1osVUFBc0QsRUFBRTtJQUV4RCxNQUFNLEVBQUUsU0FBUyxFQUFFLFFBQVEsR0FBRyxJQUFJLEVBQUUsR0FBRyxPQUFPLENBQUM7SUFFL0MsSUFBSSxJQUFBLHVCQUFjLEVBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUN4QixPQUFPLEtBQUssQ0FBQyxHQUFHLEVBQUUsRUFBRSxTQUFTLEVBQUUsQ0FBQyxDQUFDO0lBQ25DLENBQUM7SUFFRCx3QkFBd0I7SUFDeEIsSUFBSSxRQUFRLEVBQUUsQ0FBQztRQUNiLE9BQU8sQ0FBQyxLQUFLLENBQUMsbUJBQW1CLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDMUMsQ0FBQztJQUVELGdEQUFnRDtJQUNoRCxPQUFPLEtBQUssQ0FBQyxJQUFJLHNCQUFhLEVBQUUsRUFBRSxFQUFFLFNBQVMsRUFBRSxDQUFDLENBQUM7QUFDbkQsQ0FBQztBQUVEOztHQUVHO0FBQ0gsU0FBZ0IsUUFBUSxDQUN0QixRQUFnQixFQUNoQixZQUFxQixLQUFLO0lBRTFCLE9BQU87UUFDTCxVQUFVLEVBQUUsU0FBUyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEdBQUc7UUFDakMsT0FBTyxFQUFFO1lBQ1AsUUFBUSxFQUFFLFFBQVE7U0FDbkI7UUFDRCxJQUFJLEVBQUUsRUFBRTtLQUNULENBQUM7QUFDSixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBWZW50dXJlS2l0IFJlc3BvbnNlIFV0aWxpdGllc1xuICogXG4gKiBTdGFuZGFyZGl6ZWQgcmVzcG9uc2UgZm9ybWF0dGluZyBmb3IgQVBJIEdhdGV3YXkuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBBUElHYXRld2F5UHJveHlSZXN1bHRWMiB9IGZyb20gJ2F3cy1sYW1iZGEnO1xuaW1wb3J0IHsgVmVudHVyZUVycm9yLCBpc1ZlbnR1cmVFcnJvciwgSW50ZXJuYWxFcnJvciB9IGZyb20gJy4vZXJyb3JzJztcblxuLyoqXG4gKiBTdGFuZGFyZCBzdWNjZXNzIHJlc3BvbnNlXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgU3VjY2Vzc1Jlc3BvbnNlPFQgPSB1bmtub3duPiB7XG4gIGRhdGE6IFQ7XG4gIG1ldGE/OiB7XG4gICAgcmVxdWVzdElkPzogc3RyaW5nO1xuICAgIHRpbWVzdGFtcD86IHN0cmluZztcbiAgICBwYWdpbmF0aW9uPzoge1xuICAgICAgcGFnZTogbnVtYmVyO1xuICAgICAgcGFnZVNpemU6IG51bWJlcjtcbiAgICAgIHRvdGFsOiBudW1iZXI7XG4gICAgICB0b3RhbFBhZ2VzOiBudW1iZXI7XG4gICAgfTtcbiAgfTtcbn1cblxuLyoqXG4gKiBTdGFuZGFyZCBlcnJvciByZXNwb25zZVxuICovXG5leHBvcnQgaW50ZXJmYWNlIEVycm9yUmVzcG9uc2Uge1xuICBlcnJvcjoge1xuICAgIGNvZGU6IHN0cmluZztcbiAgICBtZXNzYWdlOiBzdHJpbmc7XG4gICAgZGV0YWlscz86IFJlY29yZDxzdHJpbmcsIHVua25vd24+O1xuICB9O1xuICBtZXRhPzoge1xuICAgIHJlcXVlc3RJZD86IHN0cmluZztcbiAgICB0aW1lc3RhbXA/OiBzdHJpbmc7XG4gIH07XG59XG5cbi8qKlxuICogQ3JlYXRlIGEgc3VjY2VzcyByZXNwb25zZVxuICovXG5leHBvcnQgZnVuY3Rpb24gc3VjY2VzczxUPihcbiAgZGF0YTogVCxcbiAgb3B0aW9uczoge1xuICAgIHN0YXR1c0NvZGU/OiBudW1iZXI7XG4gICAgaGVhZGVycz86IFJlY29yZDxzdHJpbmcsIHN0cmluZz47XG4gICAgcmVxdWVzdElkPzogc3RyaW5nO1xuICB9ID0ge31cbik6IEFQSUdhdGV3YXlQcm94eVJlc3VsdFYyIHtcbiAgY29uc3QgeyBzdGF0dXNDb2RlID0gMjAwLCBoZWFkZXJzID0ge30sIHJlcXVlc3RJZCB9ID0gb3B0aW9ucztcbiAgXG4gIGNvbnN0IGJvZHk6IFN1Y2Nlc3NSZXNwb25zZTxUPiA9IHtcbiAgICBkYXRhLFxuICAgIC4uLihyZXF1ZXN0SWQgJiYge1xuICAgICAgbWV0YToge1xuICAgICAgICByZXF1ZXN0SWQsXG4gICAgICAgIHRpbWVzdGFtcDogbmV3IERhdGUoKS50b0lTT1N0cmluZygpLFxuICAgICAgfSxcbiAgICB9KSxcbiAgfTtcbiAgXG4gIHJldHVybiB7XG4gICAgc3RhdHVzQ29kZSxcbiAgICBoZWFkZXJzOiB7XG4gICAgICAnQ29udGVudC1UeXBlJzogJ2FwcGxpY2F0aW9uL2pzb24nLFxuICAgICAgLi4uaGVhZGVycyxcbiAgICB9LFxuICAgIGJvZHk6IEpTT04uc3RyaW5naWZ5KGJvZHkpLFxuICB9O1xufVxuXG4vKipcbiAqIENyZWF0ZSBhIGNyZWF0ZWQgcmVzcG9uc2UgKDIwMSlcbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGNyZWF0ZWQ8VD4oXG4gIGRhdGE6IFQsXG4gIG9wdGlvbnM6IHsgaGVhZGVycz86IFJlY29yZDxzdHJpbmcsIHN0cmluZz47IHJlcXVlc3RJZD86IHN0cmluZyB9ID0ge31cbik6IEFQSUdhdGV3YXlQcm94eVJlc3VsdFYyIHtcbiAgcmV0dXJuIHN1Y2Nlc3MoZGF0YSwgeyAuLi5vcHRpb25zLCBzdGF0dXNDb2RlOiAyMDEgfSk7XG59XG5cbi8qKlxuICogQ3JlYXRlIGEgbm8gY29udGVudCByZXNwb25zZSAoMjA0KVxuICovXG5leHBvcnQgZnVuY3Rpb24gbm9Db250ZW50KG9wdGlvbnM6IHsgcmVxdWVzdElkPzogc3RyaW5nIH0gPSB7fSk6IEFQSUdhdGV3YXlQcm94eVJlc3VsdFYyIHtcbiAgcmV0dXJuIHtcbiAgICBzdGF0dXNDb2RlOiAyMDQsXG4gICAgYm9keTogJycsXG4gICAgaGVhZGVyczogb3B0aW9ucy5yZXF1ZXN0SWQgPyB7ICd4LXJlcXVlc3QtaWQnOiBvcHRpb25zLnJlcXVlc3RJZCB9IDogdW5kZWZpbmVkLFxuICB9O1xufVxuXG4vKipcbiAqIENyZWF0ZSBhbiBlcnJvciByZXNwb25zZSBmcm9tIGEgVmVudHVyZUVycm9yXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBlcnJvcihcbiAgZXJyOiBWZW50dXJlRXJyb3IsXG4gIG9wdGlvbnM6IHsgcmVxdWVzdElkPzogc3RyaW5nIH0gPSB7fVxuKTogQVBJR2F0ZXdheVByb3h5UmVzdWx0VjIge1xuICBjb25zdCB7IHJlcXVlc3RJZCB9ID0gb3B0aW9ucztcbiAgXG4gIGNvbnN0IGJvZHk6IEVycm9yUmVzcG9uc2UgPSB7XG4gICAgZXJyb3I6IHtcbiAgICAgIGNvZGU6IGVyci5jb2RlLFxuICAgICAgbWVzc2FnZTogZXJyLm1lc3NhZ2UsXG4gICAgICAuLi4oZXJyLmRldGFpbHMgJiYgeyBkZXRhaWxzOiBlcnIuZGV0YWlscyB9KSxcbiAgICB9LFxuICAgIC4uLihyZXF1ZXN0SWQgJiYge1xuICAgICAgbWV0YToge1xuICAgICAgICByZXF1ZXN0SWQsXG4gICAgICAgIHRpbWVzdGFtcDogbmV3IERhdGUoKS50b0lTT1N0cmluZygpLFxuICAgICAgfSxcbiAgICB9KSxcbiAgfTtcbiAgXG4gIHJldHVybiB7XG4gICAgc3RhdHVzQ29kZTogZXJyLnN0YXR1c0NvZGUsXG4gICAgaGVhZGVyczoge1xuICAgICAgJ0NvbnRlbnQtVHlwZSc6ICdhcHBsaWNhdGlvbi9qc29uJyxcbiAgICB9LFxuICAgIGJvZHk6IEpTT04uc3RyaW5naWZ5KGJvZHkpLFxuICB9O1xufVxuXG4vKipcbiAqIENvbnZlcnQgYW55IGVycm9yIHRvIGFuIEFQSSBHYXRld2F5IHJlc3BvbnNlXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBlcnJvclJlc3BvbnNlKFxuICBlcnI6IHVua25vd24sXG4gIG9wdGlvbnM6IHsgcmVxdWVzdElkPzogc3RyaW5nOyBsb2dFcnJvcj86IGJvb2xlYW4gfSA9IHt9XG4pOiBBUElHYXRld2F5UHJveHlSZXN1bHRWMiB7XG4gIGNvbnN0IHsgcmVxdWVzdElkLCBsb2dFcnJvciA9IHRydWUgfSA9IG9wdGlvbnM7XG4gIFxuICBpZiAoaXNWZW50dXJlRXJyb3IoZXJyKSkge1xuICAgIHJldHVybiBlcnJvcihlcnIsIHsgcmVxdWVzdElkIH0pO1xuICB9XG4gIFxuICAvLyBMb2cgdW5leHBlY3RlZCBlcnJvcnNcbiAgaWYgKGxvZ0Vycm9yKSB7XG4gICAgY29uc29sZS5lcnJvcignVW5leHBlY3RlZCBlcnJvcjonLCBlcnIpO1xuICB9XG4gIFxuICAvLyBXcmFwIGluIEludGVybmFsRXJyb3IgZm9yIGNvbnNpc3RlbnQgcmVzcG9uc2VcbiAgcmV0dXJuIGVycm9yKG5ldyBJbnRlcm5hbEVycm9yKCksIHsgcmVxdWVzdElkIH0pO1xufVxuXG4vKipcbiAqIENyZWF0ZSBhIHJlZGlyZWN0IHJlc3BvbnNlXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiByZWRpcmVjdChcbiAgbG9jYXRpb246IHN0cmluZyxcbiAgcGVybWFuZW50OiBib29sZWFuID0gZmFsc2Vcbik6IEFQSUdhdGV3YXlQcm94eVJlc3VsdFYyIHtcbiAgcmV0dXJuIHtcbiAgICBzdGF0dXNDb2RlOiBwZXJtYW5lbnQgPyAzMDEgOiAzMDIsXG4gICAgaGVhZGVyczoge1xuICAgICAgTG9jYXRpb246IGxvY2F0aW9uLFxuICAgIH0sXG4gICAgYm9keTogJycsXG4gIH07XG59XG4iXX0=
|
package/dist/ws.d.ts
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* WebSocket Connection Store
|
|
3
|
+
*
|
|
4
|
+
* DynamoDB-backed connection management for API Gateway WebSocket APIs.
|
|
5
|
+
*
|
|
6
|
+
* Authentication:
|
|
7
|
+
* Two-phase auth — the client connects without credentials, then sends
|
|
8
|
+
* an { action: "auth", token: "<jwt>" } message over the encrypted channel.
|
|
9
|
+
* The connection is stored as unauthenticated on $connect and upgraded
|
|
10
|
+
* to authenticated via connectionStore.authenticate().
|
|
11
|
+
* This avoids leaking JWTs in query strings, server logs, and access logs.
|
|
12
|
+
*
|
|
13
|
+
* Multi-tenancy:
|
|
14
|
+
* If enabled, each connection stores a tenantId alongside userId.
|
|
15
|
+
* Use sendToTenant() to broadcast within a tenant boundary.
|
|
16
|
+
*
|
|
17
|
+
* API:
|
|
18
|
+
* connectionStore.save(connectionId) — $connect (unauthenticated)
|
|
19
|
+
* connectionStore.authenticate(connectionId, metadata) — after JWT verification
|
|
20
|
+
* connectionStore.remove(connectionId) — $disconnect
|
|
21
|
+
* connectionStore.get(connectionId) — single connection
|
|
22
|
+
* connectionStore.getAll() — all connections
|
|
23
|
+
* connectionStore.getByUser(userId) — by user (GSI)
|
|
24
|
+
* connectionStore.getByTenant(tenantId) — by tenant (GSI)
|
|
25
|
+
* connectionStore.postToConnection(domain, stage, id, data) — send to one
|
|
26
|
+
* connectionStore.sendToUser(domain, stage, userId, data) — send to all user sessions
|
|
27
|
+
* connectionStore.sendToTenant(domain, stage, tenantId, data) — broadcast within tenant
|
|
28
|
+
* connectionStore.broadcast(domain, stage, data) — broadcast to all
|
|
29
|
+
*
|
|
30
|
+
* Environment variables:
|
|
31
|
+
* CONNECTIONS_TABLE — DynamoDB table name (required)
|
|
32
|
+
*
|
|
33
|
+
* DynamoDB table schema:
|
|
34
|
+
* Partition key: connectionId (String)
|
|
35
|
+
* TTL attribute: ttl
|
|
36
|
+
* GSI: userId-index (partition key: userId)
|
|
37
|
+
* GSI: tenantId-index (partition key: tenantId) — only if multi-tenancy enabled
|
|
38
|
+
*/
|
|
39
|
+
export interface ConnectionRecord {
|
|
40
|
+
connectionId: string;
|
|
41
|
+
authenticated: boolean;
|
|
42
|
+
userId?: string;
|
|
43
|
+
tenantId?: string;
|
|
44
|
+
email?: string;
|
|
45
|
+
connectedAt: number;
|
|
46
|
+
authenticatedAt?: number;
|
|
47
|
+
ttl: number;
|
|
48
|
+
[key: string]: unknown;
|
|
49
|
+
}
|
|
50
|
+
export interface ConnectionMetadata {
|
|
51
|
+
userId: string;
|
|
52
|
+
tenantId?: string;
|
|
53
|
+
email?: string;
|
|
54
|
+
[key: string]: unknown;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* WebSocket connection store backed by DynamoDB.
|
|
58
|
+
*
|
|
59
|
+
* Two-phase authentication flow:
|
|
60
|
+
*
|
|
61
|
+
* 1. $connect handler:
|
|
62
|
+
* ```typescript
|
|
63
|
+
* await connectionStore.save(connectionId);
|
|
64
|
+
* // Connection is unauthenticated, TTL = 30s
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* 2. Client sends auth message over the encrypted WebSocket:
|
|
68
|
+
* ```json
|
|
69
|
+
* { "action": "auth", "token": "<jwt>" }
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* 3. $default handler verifies JWT, then:
|
|
73
|
+
* ```typescript
|
|
74
|
+
* await connectionStore.authenticate(connectionId, { userId, tenantId, email });
|
|
75
|
+
* // Connection is now authenticated, TTL extended to 2h
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
export declare const connectionStore: {
|
|
79
|
+
/**
|
|
80
|
+
* Save a new connection on $connect.
|
|
81
|
+
* The connection is unauthenticated with a short TTL.
|
|
82
|
+
* The client must send an auth message to upgrade.
|
|
83
|
+
*/
|
|
84
|
+
save(connectionId: string): Promise<void>;
|
|
85
|
+
/**
|
|
86
|
+
* Authenticate a connection after JWT verification.
|
|
87
|
+
* Updates the record with user metadata and extends the TTL.
|
|
88
|
+
*
|
|
89
|
+
* @param connectionId — the connection to authenticate
|
|
90
|
+
* @param metadata — must include userId, optionally tenantId, email, etc.
|
|
91
|
+
*/
|
|
92
|
+
authenticate(connectionId: string, metadata: ConnectionMetadata): Promise<void>;
|
|
93
|
+
/**
|
|
94
|
+
* Remove a connection on $disconnect.
|
|
95
|
+
*/
|
|
96
|
+
remove(connectionId: string): Promise<void>;
|
|
97
|
+
/**
|
|
98
|
+
* Get a single connection record.
|
|
99
|
+
*/
|
|
100
|
+
get(connectionId: string): Promise<ConnectionRecord | null>;
|
|
101
|
+
/**
|
|
102
|
+
* Get all authenticated connections.
|
|
103
|
+
* For large-scale apps, prefer getByUser() or getByTenant().
|
|
104
|
+
*/
|
|
105
|
+
getAll(): Promise<ConnectionRecord[]>;
|
|
106
|
+
/**
|
|
107
|
+
* Get all connections for a specific user.
|
|
108
|
+
* A user can have multiple active connections (e.g. multiple tabs/devices).
|
|
109
|
+
* Requires GSI: userId-index (partition key: userId).
|
|
110
|
+
*/
|
|
111
|
+
getByUser(userId: string): Promise<ConnectionRecord[]>;
|
|
112
|
+
/**
|
|
113
|
+
* Get all connections for a specific tenant.
|
|
114
|
+
* Requires GSI: tenantId-index (partition key: tenantId).
|
|
115
|
+
*/
|
|
116
|
+
getByTenant(tenantId: string): Promise<ConnectionRecord[]>;
|
|
117
|
+
/**
|
|
118
|
+
* Send data to a specific connection via API Gateway Management API.
|
|
119
|
+
* Automatically cleans up stale connections (GoneException).
|
|
120
|
+
* Returns true if sent, false if the connection was stale and removed.
|
|
121
|
+
*/
|
|
122
|
+
postToConnection(domainName: string, stage: string, connectionId: string, data: unknown): Promise<boolean>;
|
|
123
|
+
/**
|
|
124
|
+
* Send data to all connections belonging to a specific user.
|
|
125
|
+
* Returns the number of connections that received the message.
|
|
126
|
+
*/
|
|
127
|
+
sendToUser(domainName: string, stage: string, userId: string, data: unknown): Promise<number>;
|
|
128
|
+
/**
|
|
129
|
+
* Send data to all connections within a specific tenant.
|
|
130
|
+
* Returns the number of connections that received the message.
|
|
131
|
+
*/
|
|
132
|
+
sendToTenant(domainName: string, stage: string, tenantId: string, data: unknown): Promise<number>;
|
|
133
|
+
/**
|
|
134
|
+
* Broadcast data to all authenticated connections.
|
|
135
|
+
* Returns the number of clients that received the message.
|
|
136
|
+
*/
|
|
137
|
+
broadcast(domainName: string, stage: string, data: unknown): Promise<number>;
|
|
138
|
+
};
|