import Planka upstream

2026-07-18 11:48:22 +08:00
commit c26fd3b190
1564 changed files with 214813 additions and 0 deletions
@@ -0,0 +1,72 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+/**
+ * forbidden.js
+ *
+ * A custom response.
+ *
+ * Example usage:
+ * ```
+ *     return res.forbidden();
+ *     // -or-
+ *     return res.forbidden(optionalData);
+ * ```
+ *
+ * Or with actions2:
+ * ```
+ *     exits: {
+ *       somethingHappened: {
+ *         responseType: 'forbidden'
+ *       }
+ *     }
+ * ```
+ *
+ * ```
+ *     throw 'somethingHappened';
+ *     // -or-
+ *     throw { somethingHappened: optionalData }
+ * ```
+ */
+
+/**
+ * @swagger
+ * components:
+ *   responses:
+ *     Forbidden:
+ *       description: Access forbidden - insufficient permissions
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - code
+ *               - message
+ *             properties:
+ *               code:
+ *                 type: string
+ *                 description: Error code
+ *                 example: E_FORBIDDEN
+ *               message:
+ *                 type: string
+ *                 description: Error message
+ *                 example: Not enough rights
+ */
+
+module.exports = function forbidden(message) {
+  const { res } = this;
+
+  const data = {
+    code: 'E_FORBIDDEN',
+  };
+
+  if (_.isPlainObject(message)) {
+    Object.assign(data, message);
+  } else {
+    data.message = message;
+  }
+
+  return res.status(403).json(data);
+};