feat: adds management endpoint to generate multiple suId (#3022)

Co-authored-by: Matti Nannt <mail@matthiasnannt.com>

apps/docs/app/developer-docs/rest-api/page.mdx

@@ -39,7 +39,7 @@ We currently have the following Management API methods exposed and below is thei
 - [Me API](https://documenter.getpostman.com/view/11026000/2sA3Bq5XEh#79e08365-641d-4b2d-aea2-9a855e0438ec) - Retrieve Account Information
 - [People API](https://documenter.getpostman.com/view/11026000/2sA3Bq5XEh#cffc27a6-dafb-428f-8ea7-5165bedb911e) - List and Delete People
 - [Response API](https://documenter.getpostman.com/view/11026000/2sA3Bq5XEh#e544ec0d-8b30-4e33-8d35-2441cb40d676) - List, List by Survey, Update, and Delete Responses
-- [Survey API](https://documenter.getpostman.com/view/11026000/2sA3Bq5XEh#953189b2-37b5-4429-a7bd-f4d01ceae242) - List, Create, Update, and Delete Surveys
+- [Survey API](https://documenter.getpostman.com/view/11026000/2sA3Bq5XEh#953189b2-37b5-4429-a7bd-f4d01ceae242) - List, Create, Update, generate multiple suId and Delete Surveys
 - [Webhook API](https://documenter.getpostman.com/view/11026000/2sA3Bq5XEh#62e6ec65-021b-42a4-ac93-d1434b393c6c) - List, Create, and Delete Webhooks
 
 ## How to Generate an API key

apps/web/app/api/v1/management/surveys/[surveyId]/singleUseIds/route.ts

@@ -0,0 +1,47 @@
+import { authenticateRequest, handleErrorResponse } from "@/app/api/v1/auth";
+import { responses } from "@/app/lib/api/response";
+import { NextRequest } from "next/server";
+import { getSurvey } from "@formbricks/lib/survey/service";
+import { generateSurveySingleUseIds } from "@formbricks/lib/utils/singleUseSurveys";
+
+export const GET = async (
+  request: NextRequest,
+  { params }: { params: { surveyId: string } }
+): Promise<Response> => {
+  try {
+    const authentication = await authenticateRequest(request);
+    if (!authentication) return responses.notAuthenticatedResponse();
+    const survey = await getSurvey(params.surveyId);
+    if (!survey) {
+      return responses.notFoundResponse("Survey", params.surveyId);
+    }
+    if (survey.environmentId !== authentication.environmentId) {
+      throw new Error("Unauthorized");
+    }
+
+    if (!survey.singleUse || !survey.singleUse.enabled) {
+      return responses.badRequestResponse("Single use links are not enabled for this survey");
+    }
+    const searchParams = request.nextUrl.searchParams;
+    const limit = searchParams.get("limit") ? Number(searchParams.get("limit")) : 10;
+
+    if (limit < 1) {
+      return responses.badRequestResponse("Limit cannot be less than 1");
+    }
+
+    if (limit > 5000) {
+      return responses.badRequestResponse("Limit cannot be more than 5000");
+    }
+
+    const singleUseIds = generateSurveySingleUseIds(limit, survey.singleUse.isEncrypted);
+
+    // map single use ids to survey links
+    const surveyLinks = singleUseIds.map(
+      (singleUseId) => `${process.env.WEBAPP_URL}/s/${survey.id}?suId=${singleUseId}`
+    );
+
+    return responses.successResponse(surveyLinks);
+  } catch (error) {
+    return handleErrorResponse(error);
+  }
+};

packages/lib/utils/singleUseSurveys.ts

@@ -13,6 +13,16 @@ export const generateSurveySingleUseId = (isEncrypted: boolean): string => {
   return encryptedCuid;
 };
 
+export const generateSurveySingleUseIds = (count: number, isEncrypted: boolean): string[] => {
+  const singleUseIds: string[] = [];
+
+  for (let i = 0; i < count; i++) {
+    singleUseIds.push(generateSurveySingleUseId(isEncrypted));
+  }
+
+  return singleUseIds;
+};
+
 // validate the survey single use id
 export const validateSurveySingleUseId = (surveySingleUseId: string): string | undefined => {
   try {