add addCookie helper to common utilities

[squeep-api-dingus] / lib / common.js

diff --git a/lib/common.js b/lib/common.js
index 6b72129223cf88e8248706afa5679f853eb5d5ae..162b751ef23805d30bbf97eb71a69f367adf3d59 100644 (file)
--- a/lib/common.js
+++ b/lib/common.js
@@ -194,7 +194,68 @@ const unfoldHeaderLines = (lines) => {
   return lines;
 };
 
+/**
+ * Adds a new cookie.
+ * @param {http.ServerResponse} res
+ * @param {String} name
+ * @param {String} value
+ * @param {Object=} opt
+ * @param {String=} opt.domain
+ * @param {Date=} opt.expires
+ * @param {Boolean=} opt.httpOnly
+ * @param {Number=} opt.maxAge
+ * @param {String=} opt.path
+ * @param {String=} opt.sameSite
+ * @param {Boolean=} opt.secure
+ */
+function addCookie(res, name, value, opt = {}) {
+  const options = {
+    domain: undefined,
+    expires: undefined,
+    httpOnly: false,
+    maxAge: undefined,
+    path: undefined,
+    sameSite: undefined,
+    secure: false,
+    ...opt,
+  };
+  // TODO: validate name, value
+  const cookieParts = [
+    `${name}=${value}`,
+  ];
+  if (options.domain) {
+    cookieParts.push(`Domain=${options.domain}`);
+  }
+  if (options.expires) {
+    if (!(options.expires instanceof Date)) {
+      throw new TypeError('cookie expires must be Date');
+    }
+    cookieParts.push(`Expires=${options.expires.toUTCString()}`);
+  }
+  if (options.httpOnly) {
+    cookieParts.push('HttpOnly');
+  }
+  if (options.maxAge) {
+    cookieParts.push(`Max-Age=${options.maxAge}`);
+  }
+  if (options.path) {
+    cookieParts.push(`Path=${options.path}`);
+  }
+  if (options.sameSite) {
+    if (!(['Strict', 'Lax', 'None'].includes(options.sameSite))) {
+      throw new RangeError('cookie sameSite value not valid');
+    }
+    cookieParts.push(`SameSite=${options.sameSite}`);
+  }
+  if (options.secure) {
+    cookieParts.push('Secure');
+  }
+  res.appendHeader(Enum.Header.SetCookie, cookieParts.join('; '));
+}
+
+
 module.exports = {
+  addCookie,
   fileScope,
   generateETag,
   get,