Make API extensible

.gitignore

@@ -29,3 +29,6 @@ Temporary Items
 
 .rcappsconfig
 .vscode
+
+package-lock.json
+yarn.lock

FigmaApp.ts

@@ -37,6 +37,7 @@ import { BlockActionHandler } from './src/handlers/BlockActionHandler';
 import { ExecuteReplyHandler } from './src/handlers/reply';
 import { modalTitle } from './src/enums/enums';
 import { CommentModalHandler } from './src/handlers/comment';
+import { meUrl } from './src/lib/const';
 
 export class FigmaApp extends App {
     constructor(info: IAppInfo, logger: ILogger, accessors: IAppAccessors) {
@@ -190,7 +191,8 @@ export class FigmaApp extends App {
         persistence: IPersistence
     ) {
         if (authData) {
-            const userData = await http.get('https://api.figma.com/v1/me', {
+            const url = meUrl()
+            const userData = await http.get(url, {
                 headers: {
                     Authorization: `Bearer ${authData.token}`
                 }

src/handlers/action.ts

@@ -19,6 +19,7 @@ import { botNotifyCurrentUser, sendMessage } from '../lib/messages';
 import { IUser } from '@rocket.chat/apps-engine/definition/users';
 import { IRoom } from '@rocket.chat/apps-engine/definition/rooms';
 import { getRequest } from '../helpers/Figma.sdk';
+import { getProjectFilesUrl, getTeamProjectsUrl } from '../lib/const';
 
 type file = {
     key: string;
@@ -63,14 +64,14 @@ export class BlockActionHandler {
                 success: false
             };
         }
-
+        const teamUrl=getTeamProjectsUrl(teamId);
         switch (resource_type) {
             case 'file':
                 await getRequest(
                     this.read,
                     context,
                     this.http,
-                    `https://api.figma.com/v1/teams/${teamId}/projects`
+                    teamUrl
                 )
                     .then(async (res: IHttpResponse) => {
                         if (!res) {
@@ -92,7 +93,7 @@ export class BlockActionHandler {
                         if (projectIds) {
                             const reqUrls = projectIds.map(
                                 (projectId) =>
-                                    `https://api.figma.com/v1/projects/${projectId}/files`
+                                    getProjectFilesUrl(projectId)
                             );
 
                             try {
@@ -200,7 +201,7 @@ export class BlockActionHandler {
                     this.read,
                     context,
                     this.http,
-                    `https://api.figma.com/v1/teams/${teamId}/projects`
+                    teamUrl
                 )
                     .then(async (res) => {
                         if (!res) {

src/handlers/comment.ts

@@ -9,6 +9,7 @@ import {
 import { IRoom } from '@rocket.chat/apps-engine/definition/rooms';
 import { UIKitViewSubmitInteractionContext } from '@rocket.chat/apps-engine/definition/uikit';
 import { FigmaApp } from '../../FigmaApp';
+import { getFileCommentsUrl } from '../lib/const';
 import { botNotifyCurrentUser } from '../lib/messages';
 import { getAccessTokenForUser } from '../storage/users';
 
@@ -35,9 +36,10 @@ export class CommentModalHandler {
                 }
             };
             console.log('post data - ', postData, view.commentData);
+            const url = getFileCommentsUrl(view.commentData);
             this.http
                 .post(
-                    `https://api.figma.com/v1/files/${view.commentData}/comments`,
+                    url,
                     postData
                 )
                 .then(async (res) => {

src/handlers/reply.ts

@@ -9,6 +9,7 @@ import {
 import { IRoom } from '@rocket.chat/apps-engine/definition/rooms';
 import { UIKitViewSubmitInteractionContext } from '@rocket.chat/apps-engine/definition/uikit';
 import { FigmaApp } from '../../FigmaApp';
+import { getFileCommentsUrl } from '../lib/const';
 import { botNotifyCurrentUser } from '../lib/messages';
 import { getAccessTokenForUser } from '../storage/users';
 
@@ -36,10 +37,10 @@ export class ExecuteReplyHandler {
                 }
             };
             console.log('post data - ', postData, view.block);
-
+            const url = getFileCommentsUrl(view.commentData.fileKey);
             this.http
                 .post(
-                    `https://api.figma.com/v1/files/${view.commentData.fileKey}/comments`,
+                    url,
                     postData
                 )
                 .then(async (res) => {

src/helpers/getResources.ts

@@ -4,6 +4,7 @@ import {
     IRead
 } from '@rocket.chat/apps-engine/definition/accessors';
 import { UIKitViewSubmitInteractionContext } from '@rocket.chat/apps-engine/definition/uikit';
+import { getProjectFilesUrl, getTeamProjectsUrl } from '../lib/const';
 import { getRequest } from './Figma.sdk';
 
 export class GetResourcesFromFigma {
@@ -13,15 +14,16 @@ export class GetResourcesFromFigma {
         context: UIKitViewSubmitInteractionContext,
         teamId: string
     ) {
+        const url = getTeamProjectsUrl(teamId);
         await getRequest(
             this.read,
             context,
             this.http,
-            `https://api.figma.com/v1/teams/${teamId}/projects`
+            url
         ).then(async (team_response) => {
             const reqUrls = team_response.data.projects.map(
                 (project: any) =>
-                    `https://api.figma.com/v1/projects/${project.id}/files`
+                    getProjectFilesUrl(project.id)
             );
             return await Promise.all(
                 reqUrls.map(
@@ -35,11 +37,12 @@ export class GetResourcesFromFigma {
         context: UIKitViewSubmitInteractionContext,
         teamId: string
     ) {
+        const url2=getTeamProjectsUrl(teamId);
         await getRequest(
             this.read,
             context,
             this.http,
-            `https://api.figma.com/v1/teams/${teamId}/projects`
+            url2
         ).then((res) => {
             console.log('response from figma for projects - ', res.data);
         });

src/helpers/teamFiles.ts

@@ -5,6 +5,7 @@ import {
     IRead
 } from '@rocket.chat/apps-engine/definition/accessors';
 import { UIKitViewSubmitInteractionContext } from '@rocket.chat/apps-engine/definition/uikit';
+import { getProjectFilesUrl, getTeamProjectsUrl } from '../lib/const';
 import { getRequest } from './Figma.sdk';
 
 // create a function to get all the files inside a project from figma using this code
@@ -15,15 +16,16 @@ export async function getAllTeamFiles(
     http: IHttp,
     teamId: string
 ) {
+    const teamUrl=getTeamProjectsUrl(teamId);
     await getRequest(
         this.read,
         context,
         this.http,
-        `https://api.figma.com/v1/teams/${teamId}/projects`
+        teamUrl
     ).then(async (team_response) => {
         const reqUrls = team_response.data.projects.map(
             (project: any) =>
-                `https://api.figma.com/v1/projects/${project.id}/files`
+                getProjectFilesUrl(project.id)
         );
         try {
             await Promise.all(

src/lib/const.ts

@@ -0,0 +1,41 @@
+const ApiBaseUrl: string = 'https://api.figma.com';
+
+const ApiVersion = {
+    V1: 'v1',
+    V2: 'v2'
+};
+
+const ApiEndpoint = {
+    Team:'teams',
+    Project:'projects',
+    File:'files',
+    Webhook:'webhooks',
+    Comment:'comments',
+    Me:'me'
+};
+
+export const getTeamProjectsUrl =(teamId:string)=>{
+    return `${ApiBaseUrl}/${ApiVersion.V1}/${ApiEndpoint.Team}/${teamId}/${ApiEndpoint.Project}`;
+};
+
+export const getProjectFilesUrl =(projectId:string)=>{
+    return `${ApiBaseUrl}/${ApiVersion.V1}/${ApiEndpoint.Project}/${projectId}/${ApiEndpoint.File}`;
+};
+
+export const getFilesUrl =(fileId:string)=>{
+    return `${ApiBaseUrl}/${ApiVersion.V1}/${ApiEndpoint.File}/${fileId}`;
+};
+
+export const getFileCommentsUrl =(fileId:string)=>{
+    return `${ApiBaseUrl}/${ApiVersion.V1}/${ApiEndpoint.File}/${fileId}/${ApiEndpoint.Comment}`;
+};
+
+export const webHooksUrl =()=>{
+    return `${ApiBaseUrl}/${ApiVersion.V2}/${ApiEndpoint.Webhook}`;
+};
+
+export const meUrl =()=>{
+    return `${ApiBaseUrl}/${ApiVersion.V2}/${ApiEndpoint.Me}`;
+};
+
+

src/lib/createSubscriptionMessage.ts

@@ -29,6 +29,7 @@ import {
     RocketChatAssociationRecord,
 } from "@rocket.chat/apps-engine/definition/metadata";
 import { IModalContext } from "../definition";
+import { getFilesUrl, getProjectFilesUrl, getTeamProjectsUrl } from "./const";
 
 export async function createSubscription(
     context: UIKitViewSubmitInteractionContext,
@@ -71,9 +72,9 @@ export async function createSubscription(
             }
             return;
         }
-
+        const fileUrl=getFilesUrl(fileId);
         const response = await http.get(
-            `https://api.figma.com/v1/files/${fileId}`,
+            fileUrl,
             { headers }
         );
 
@@ -119,8 +120,9 @@ export async function createSubscription(
             }
             return;
         }
+        const teamUrl=getTeamProjectsUrl(teamId);
         const response = await http.get(
-            `https://api.figma.com/v1/teams/${teamId}/projects`,
+            teamUrl,
             { headers }
         );
 
@@ -161,9 +163,9 @@ export async function createSubscription(
             }
             return;
         }
-
+        const projecturl=getProjectFilesUrl(projectID);
         const response = await http.get(
-            `https://api.figma.com/v1/projects/${projectID}/files`,
+            projecturl,
             { headers }
         );
 

src/lib/getFiles.ts

@@ -13,6 +13,7 @@ import { storedRoomData } from '../definition';
 import { botMessageChannel, botNotifyCurrentUser } from './messages';
 import { TextObjectType } from '@rocket.chat/apps-engine/definition/uikit';
 import { blockAction } from '../enums/enums';
+import { getFilesUrl } from './const';
 
 export async function getFiles(
     modify: IModify,
@@ -78,7 +79,7 @@ export async function getFiles(
                 );
             }
             const filesDataReqUrls = removeDuplicates(room_files_ids).map(
-                (file_id) => `https://api.figma.com/v1/files/${file_id}`
+                (file_id) => getFilesUrl(file_id)
             );
             try {
                 await Promise.all(

src/lib/getProjects.ts

@@ -16,6 +16,7 @@ import {
 } from './messages';
 import { TextObjectType } from '@rocket.chat/apps-engine/definition/uikit';
 import { blockAction } from '../enums/enums';
+import { getProjectFilesUrl } from './const';
 
 export async function getProjects(
     modify: IModify,
@@ -86,7 +87,7 @@ export async function getProjects(
                 room_projects_ids
             ).map(
                 (projectId) =>
-                    `https://api.figma.com/v1/projects/${projectId}/files`
+                    getProjectFilesUrl(projectId)
             );
             try {
                 await Promise.all(

src/lib/sdk.ts

@@ -1,5 +1,7 @@
 import { IHttp } from "@rocket.chat/apps-engine/definition/accessors";
 import { IUser } from "@rocket.chat/apps-engine/definition/users";
+import { getWebhookUrl } from "../sdk/subscription.sdk";
+import { webHooksUrl } from "./const";
 const crypto = require("crypto");
 
 const BaseFileHost = "https://www.figma.com/file/";
@@ -14,7 +16,8 @@ export class FigmaSDK {
     constructor(private readonly http: IHttp, private readonly accessToken) {}
 
     public createWebhook(fileID: string, webhookUrl: string) {
-        return this.post("https://api.figma.com/v2/webhooks", {
+        const webhookurl=webHooksUrl()
+        return this.post(webhookurl, {
             active: true,
             event_type: "FILE_COMMENT",
             team_id: "1051788064684166795",

src/subscription/addSubscription.ts

@@ -21,6 +21,7 @@ import { events } from '../enums/enums';
 import { WebhookSubscription } from '../handlers/subscription/createSubscriptionHandler';
 import { updateSubscriptionHandler } from '../handlers/subscription/updateSubscriptionHandler';
 import { getRequest, postRequest } from '../helpers/Figma.sdk';
+import { getProjectFilesUrl, getTeamProjectsUrl, webHooksUrl } from '../lib/const';
 
 export class AddSubscription {
     constructor(
@@ -109,11 +110,12 @@ export class AddSubscription {
                                 const files_in_team: string[] = [];
                                 const projects_in_team: string[] = [];
                                 if (!project_Ids?.length && !file_Ids?.length) {
+                                    const teamUrl=getTeamProjectsUrl(team_id);
                                     await getRequest(
                                         this.read,
                                         context,
                                         this.http,
-                                        `https://api.figma.com/v1/teams/${team_id}/projects`
+                                        teamUrl
                                     )
                                         .then(async (team_response) => {
                                             //console.log('response from figma for projects - ', team_response);
@@ -124,7 +126,7 @@ export class AddSubscription {
                                                         projects_in_team.push(
                                                             project.id
                                                         );
-                                                        return `https://api.figma.com/v1/projects/${project.id}/files`;
+                                                        return getProjectFilesUrl(project.id);
                                                     }
                                                 );
                                             if (projects_in_team) {
@@ -308,11 +310,12 @@ export class AddSubscription {
                                             description: room.id
                                         };
                                         // we send request to figma webhook to create a hook for every event ( runs 5 times )
+                                        const webhookurl=webHooksUrl();
                                         await postRequest(
                                             this.read,
                                             context,
                                             this.http,
-                                            'https://api.figma.com/v2/webhooks',
+                                            webhookurl,
                                             data
                                         )
                                             .then(async (response) => {

src/subscription/project/newProjectSubscription.ts

@@ -13,6 +13,7 @@ import {
 import { IUser } from '@rocket.chat/apps-engine/definition/users';
 import { file } from '../../definition';
 import { getRequest } from '../../helpers/Figma.sdk';
+import { getProjectFilesUrl } from '../../lib/const';
 import { botMessageChannel } from '../../lib/messages';
 import { Subscription } from '../../sdk/webhooks.sdk';
 import { getAccessTokenForUser } from '../../storage/users';
@@ -45,11 +46,12 @@ export async function newProjectSubscription(
         await Promise.all(
             project_Ids.map(async (project_id) => {
                 // this will run for all project ids for all these store them in one file
+                const projecturl=getProjectFilesUrl(project_id);
                 await getRequest(
                     read,
                     context,
                     http,
-                    `https://api.figma.com/v1/projects/${project_id}/files`
+                    projecturl
                 )
                     .then(async (response) => {
                         // 3 - got the files from figma