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,127 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+/**
+ * @swagger
+ * /users/{userId}/notification-services:
+ *   post:
+ *     summary: Create notification service for user
+ *     description: Creates a new notification service for a user. Users can only create services for themselves.
+ *     tags:
+ *       - Notification Services
+ *     operationId: createUserNotificationService
+ *     parameters:
+ *       - name: userId
+ *         in: path
+ *         required: true
+ *         description: ID of the user to create notification service for (must be the current user)
+ *         schema:
+ *           type: string
+ *           example: "1357158568008091264"
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - url
+ *               - format
+ *             properties:
+ *               url:
+ *                 type: string
+ *                 maxLength: 512
+ *                 description: URL endpoint for notifications
+ *                 example: https://service.example.com/planka
+ *               format:
+ *                 type: string
+ *                 enum: [text, markdown, html]
+ *                 description: Format for notification messages
+ *                 example: text
+ *     responses:
+ *       200:
+ *         description: Notification service created successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/NotificationService'
+ *       400:
+ *         $ref: '#/components/responses/ValidationError'
+ *       401:
+ *         $ref: '#/components/responses/Unauthorized'
+ *       404:
+ *         $ref: '#/components/responses/NotFound'
+ *       409:
+ *         $ref: '#/components/responses/Conflict'
+ */
+
+const { idInput } = require('../../../utils/inputs');
+
+const Errors = {
+  USER_NOT_FOUND: {
+    userNotFound: 'User not found',
+  },
+  LIMIT_REACHED: {
+    limitReached: 'Limit reached',
+  },
+};
+
+module.exports = {
+  inputs: {
+    userId: {
+      ...idInput,
+      required: true,
+    },
+    url: {
+      type: 'string',
+      maxLength: 512,
+      required: true,
+    },
+    format: {
+      type: 'string',
+      isIn: Object.values(NotificationService.Formats),
+      required: true,
+    },
+  },
+
+  exits: {
+    userNotFound: {
+      responseType: 'notFound',
+    },
+    limitReached: {
+      responseType: 'conflict',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    if (inputs.userId !== currentUser.id) {
+      throw Errors.USER_NOT_FOUND; // Forbidden
+    }
+
+    const values = _.pick(inputs, ['url', 'format']);
+
+    const notificationService = await sails.helpers.notificationServices.createOneInUser
+      .with({
+        values: {
+          ...values,
+          user: currentUser,
+        },
+        actorUser: currentUser,
+        request: this.req,
+      })
+      .intercept('limitReached', () => Errors.LIMIT_REACHED);
+
+    return {
+      item: notificationService,
+    };
+  },
+};