docs(app): explain common API session workspace and geometry helpers

This commit is contained in:
2026-11-12 01:36:26 +08:00
parent c488bc86b6
commit aacafa7a9b
8 changed files with 103 additions and 0 deletions
+9
View File
@@ -1,9 +1,18 @@
/**
* 服务端会话Cookie的纯字符串与寿命辅助,不读取或写入浏览器Cookie。
* 调用方决定何时采用上游过期提示、是否Secure,并把返回字符串放进响应Set-Cookie。
*/
/** 本应用默认空闲期上限30天,单位秒。 */
export const SESSION_IDLE_SECONDS = 30 * 24 * 60 * 60;
/** 上游向代理传递剩余会话寿命的响应头名,不是Cookie名。 */
export const SESSION_EXPIRY_HEADER = "X-Foundry-Session-Expires-In";
/** 数字或纯数字字符串可采用,非负安全整数封顶30天,0可用于清除。
* 不合法输入原样退回fallback;自定义fallback由调用方提供有效值,不在此再次封顶。 */
export function sessionMaxAge(value: unknown, fallback = SESSION_IDLE_SECONDS) {
const seconds = typeof value === "number" ? value : typeof value === "string" && /^\d+$/.test(value) ? Number(value) : NaN;
return Number.isSafeInteger(seconds) && seconds >= 0 ? Math.min(seconds, SESSION_IDLE_SECONDS) : fallback;
}
/** URL编码会话值,固定HttpOnly/SameSite=Lax/根路径并规范Max-Age;secure参数为true才添加Secure。 */
export function sessionCookie(value: string, maxAge: number, secure: boolean) {
return `foundry_session=${encodeURIComponent(value)}; HttpOnly; SameSite=Lax; Path=/; Max-Age=${sessionMaxAge(maxAge)}${secure ? "; Secure" : ""}`;
}