@ever-gauzy/plugin-integration-plane-api 0.1.0

package/dist/config/serializers/comments/comment.serializer.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.issueCommentTrasnsformer = issueCommentTrasnsformer;
+exports.createCommentInputTransformer = createCommentInputTransformer;
+exports.updateCommentInputTransformer = updateCommentInputTransformer;
+exports.getCommentsQuery = getCommentsQuery;
+const plugin_integration_plane_models_1 = require("@ever-gauzy/plugin-integration-plane-models");
+const query_params_serializers_1 = require("../query-params.serializers");
+const projects_1 = require("../projects");
+const utils_1 = require("../../utils");
+const user_1 = require("../user");
+/**
+ * Transforms a comment object to a standardized format.
+ *
+ * @param {IComment[] | IComment} comments - The comment object to be transformed.
+ * @param {IIssue} issue - The issue object associated with the comment.
+ * @param {IOrganizationProject} project - The project object associated with the comment.
+ * @param {IWorkspaceInfo} workspace_detail - The workspace object associated with the comment.
+ * @param {IReactionData[]} reactions - The reactions associated with the comment.
+ * @param {IEmployee} employee - The employee object associated with the comment.
+ * @returns {IIssueComment[] | IIssueComment} The transformed comment object in a standardized format.
+ */
+function issueCommentTrasnsformer(comments, issue, project, workspace_detail, reactions, employee) {
+    const transformIssueComment = (comment) => {
+        return {
+            id: comment.id,
+            issue_detail: issue,
+            actor_detail: (0, user_1.actorDetailsTransformer)(comment.employee || employee),
+            project_detail: (0, projects_1.getProjectsResponse)([project])[0],
+            workspace_detail,
+            comment_reactions: reactions,
+            created_at: comment.createdAt,
+            updated_at: comment.updatedAt,
+            deleted_at: comment.deletedAt,
+            comment_stripped: comment.comment,
+            comment_json: {},
+            comment_html: comment.comment,
+            attachments: [],
+            access: 'INTERNAL',
+            external_source: null,
+            external_id: null,
+            created_by: comment.createdByUserId,
+            updated_by: undefined,
+            project: project.id,
+            workspace: workspace_detail.id,
+            issue: issue.id,
+            actor: comment.employeeId || employee.id
+        };
+    };
+    if (Array.isArray(comments)) {
+        return comments.map(transformIssueComment);
+    }
+    return transformIssueComment(comments);
+}
+/**
+ * Transforms the input from the front-end into a format suitable for creating a comment.
+ *
+ * @param input - The comment input data from the front-end.
+ * @param entity - The type of entity associated with the comment (e.g., Task, Project).
+ * @param entityId - The ID of the associated entity.
+ * @param employees - Optional list of employees for mapping mentioned employee IDs to user IDs.
+ * @returns The transformed comment input ready for back-end processing.
+ */
+function createCommentInputTransformer(input, entity, entityId, employees) {
+    const commentHtml = input.comment_html;
+    // Extract employee IDs mentioned in the comment
+    const mentionedEmployeeIds = (0, utils_1.extractEmployeeMentionIds)(commentHtml);
+    // Map employee IDs to user IDs
+    const mentionUserIds = employees === null || employees === void 0 ? void 0 : employees.filter(({ id }) => mentionedEmployeeIds.includes(id)).map((employee) => employee.userId).filter((userId) => !!userId); // Ensure user IDs are valid (non-null/undefined)
+    return {
+        entity,
+        entityId,
+        comment: commentHtml,
+        actorType: plugin_integration_plane_models_1.ActorTypeEnum.User,
+        mentionUserIds: mentionUserIds !== null && mentionUserIds !== void 0 ? mentionUserIds : [], // Default to an empty array if no employees are provided
+        entityName: input.entityName
+    };
+}
+function updateCommentInputTransformer(input, commentUpdate) {
+    return Object.assign(Object.assign({}, commentUpdate), { comment: input.comment_html });
+}
+function getCommentsQuery(entityId, entity) {
+    // Tenant and Organization based query
+    const query = Object.assign({}, (0, query_params_serializers_1.baseGetItemsWhereQuery)());
+    if (entityId) {
+        query['where[entityId]'] = entityId;
+    }
+    if (entity) {
+        query['where[entity]'] = entity;
+    }
+    query['relations[0]'] = 'employee';
+    return query;
+}
+//# sourceMappingURL=comment.serializer.js.map

package/dist/config/serializers/comments/comment.serializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.serializer.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-plane/src/config/serializers/comments/comment.serializer.ts"],"names":[],"mappings":";;AA+BA,4DAwCC;AAWD,sEAyBC;AAED,sEAQC;AAED,4CAoBC;AA3ID,iGAcqD;AACrD,0EAAqE;AACrE,0CAAkD;AAClD,uCAAwD;AACxD,kCAAkD;AAElD;;;;;;;;;;GAUG;AACH,SAAgB,wBAAwB,CACvC,QAA+B,EAC/B,KAAa,EACb,OAA6B,EAC7B,gBAAgC,EAChC,SAA0B,EAC1B,QAAmB;IAEnB,MAAM,qBAAqB,GAAG,CAAC,OAAiB,EAAiB,EAAE;QAClE,OAAO;YACN,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,YAAY,EAAE,KAAK;YACnB,YAAY,EAAE,IAAA,8BAAuB,EAAC,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC;YACnE,cAAc,EAAE,IAAA,8BAAmB,EAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YACjD,gBAAgB;YAChB,iBAAiB,EAAE,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,gBAAgB,EAAE,OAAO,CAAC,OAAO;YACjC,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,OAAO,CAAC,OAAO;YAC7B,WAAW,EAAE,EAAE;YACf,MAAM,EAAE,UAAU;YAClB,eAAe,EAAE,IAAI;YACrB,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,OAAO,CAAC,eAAe;YACpC,UAAU,EAAE,SAAS;YACrB,OAAO,EAAE,OAAO,CAAC,EAAE;YAClB,SAAS,EAAE,gBAAgB,CAAC,EAAE;YAC9B,KAAK,EAAE,KAAK,CAAC,EAAE;YACf,KAAK,EAAE,OAAO,CAAC,UAAU,IAAI,QAAQ,CAAC,EAAE;SACxC,CAAC;IACH,CAAC,CAAC;IAEF,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,OAAO,QAAQ,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,qBAAqB,CAAC,QAAQ,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,6BAA6B,CAC5C,KAA0B,EAC1B,MAAsB,EACtB,QAAY,EACZ,SAAuB;IAEvB,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC;IAEvC,gDAAgD;IAChD,MAAM,oBAAoB,GAAG,IAAA,iCAAyB,EAAC,WAAW,CAAC,CAAC;IAEpE,+BAA+B;IAC/B,MAAM,cAAc,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAC7B,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAG,CAAC,EACtD,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAO,EAClC,MAAM,CAAC,CAAC,MAAM,EAAgB,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,iDAAiD;IAE/F,OAAO;QACN,MAAM;QACN,QAAQ;QACR,OAAO,EAAE,WAAW;QACpB,SAAS,EAAE,+CAAa,CAAC,IAAI;QAC7B,cAAc,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,EAAE,yDAAyD;QAC/F,UAAU,EAAE,KAAK,CAAC,UAAU;KAC5B,CAAC;AACH,CAAC;AAED,SAAgB,6BAA6B,CAC5C,KAA0B,EAC1B,aAAuB;IAEvB,uCACI,aAAa,KAChB,OAAO,EAAE,KAAK,CAAC,YAAY,IAC1B;AACH,CAAC;AAED,SAAgB,gBAAgB,CAC/B,QAAa,EACb,MAAuB;IAEvB,sCAAsC;IACtC,MAAM,KAAK,qBACP,IAAA,iDAAsB,GAAE,CAC3B,CAAC;IAEF,IAAI,QAAQ,EAAE,CAAC;QACd,KAAK,CAAC,iBAAiB,CAAC,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACZ,KAAK,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC;IAEnC,OAAO,KAAK,CAAC;AACd,CAAC"}

package/dist/config/serializers/comments/index.d.ts

@@ -0,0 +1 @@
+export * from './comment.serializer';

package/dist/config/serializers/comments/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./comment.serializer"), exports);
+//# sourceMappingURL=index.js.map

package/dist/config/serializers/comments/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-plane/src/config/serializers/comments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC"}

package/dist/config/serializers/cycles/cycle.serializer.d.ts

@@ -0,0 +1,86 @@
+import { CycleStatusEnum, ICycle, ICycleAnalytics, ICycleIssuesResponse, ID, IIssue, IOrganizationSprint, IOrganizationSprintCreateInput, IOrganizationSprintUpdateInput, ITask, OrganizationSprintStatusEnum } from '@ever-gauzy/plugin-integration-plane-models';
+/**
+ * Converts a cycle status to the corresponding sprint status.
+ *
+ * @param {CycleStatusEnum} cycleStatus - The cycle status to convert.
+ * @returns {OrganizationSprintStatusEnum} The corresponding sprint status.
+ * @throws Will throw an error if the cycle status is not recognized.
+ */
+export declare function cycleStatusToSprintStatus(cycleStatus: CycleStatusEnum): OrganizationSprintStatusEnum;
+/**
+ * Converts a sprint status to the corresponding cycle status.
+ *
+ * @param {OrganizationSprintStatusEnum} sprintStatus - The sprint status to convert.
+ * @returns {CycleStatusEnum} The corresponding cycle status.
+ * @throws Will throw an error if the sprint status is not recognized.
+ */
+export declare function sprintStatusToCycleStatus(sprintStatus: OrganizationSprintStatusEnum): CycleStatusEnum;
+/**
+ * Transforms a cycle object into an input suitable for creating an organization sprint.
+ *
+ * @param {ICycle} cycle - The cycle object containing information about the sprint.
+ * @returns {IOrganizationSprintCreateInput} - The transformed input for creating the sprint.
+ */
+export declare function createCycleInputTransformer(cycle: ICycle): IOrganizationSprintCreateInput;
+/**
+ * Transforms a cycle object into an input suitable for updating an organization sprint.
+ *
+ * @param {ICycle} cycle - The cycle object containing information about the sprint.
+ * @returns {IOrganizationSprintUpdateInput} - The transformed input for updating the sprint.
+ */
+export declare function updateCycleInputTransformer(cycle: Partial<Omit<ICycle, 'id'>>): IOrganizationSprintUpdateInput;
+/**
+ * @description Transform sprints from external API to accpeted data for internal use
+ * @param {(IOrganizationSprint | IOrganizationSprint[])} sprints - External Sprints
+ * @param {ID[]} [favoriteIds] - User favorites list
+ * @returns {(ICycle | ICycle[])} An array of or single Cycle
+ */
+export declare function cycleTransformer(sprints: IOrganizationSprint | IOrganizationSprint[], favoriteIds?: ID[]): ICycle | ICycle[];
+export declare const cycleRelations: string[];
+/**
+ * Cycle relations including task members (assignees) for cycle-issues endpoint.
+ * Use these relations when fetching cycle issues to ensure assignee_ids are populated.
+ */
+export declare const cycleIssueRelations: string[];
+/**
+ * @description Query params for getting sprints
+ * @param {ID} [projectId] - Optional Project ID to get sprints by Project filter
+ * @returns {Record<string, string>} A object with queries filters and relations
+ */
+export declare function getSprintsQuery(projectId?: ID, relations?: string[]): Record<string, string>;
+export declare function cycleIssueTransformer(issues: IIssue[]): ICycleIssuesResponse;
+/**
+ * Retrieves the total list of unique tasks associated with a given sprint,
+ * including tasks from the current sprint, previous sprint histories, and
+ * the sprint's directly associated tasks.
+ *
+ * @param {IOrganizationSprint} sprint - The sprint object containing task histories and tasks.
+ * @returns {ITask[]} - An array of unique tasks associated with the sprint.
+ *
+ * @remarks
+ * - The function extracts tasks from the `toSprintTaskHistories` (current sprint tasks),
+ *   `fromSprintTaskHistories` (previous sprint tasks), and `tasks` (directly associated tasks).
+ * - Tasks are deduplicated based on their `id` property to ensure uniqueness.
+ * - If a task exists in multiple sources, the task from `currentTasks` is prioritized
+ *   over `previousTasks`.
+ */
+export declare function retrieveCycleTotalTasks(sprint: IOrganizationSprint): ITask[];
+/**
+ * Transforms sprint/cycle data into analytics format, calculating statistics about tasks, assignees, and labels.
+ *
+ * This function processes a sprint's tasks and their histories to generate comprehensive analytics including:
+ * - Task distribution across assignees (including unassigned tasks)
+ * - Task distribution across labels (including unlabeled tasks)
+ * - Task completion status over time
+ *
+ * @param {IOrganizationSprint} sprint - The sprint/cycle to analyze, containing:
+ *   - tasks: Current tasks in the sprint
+ *   - toSprintTaskHistories: History of tasks added to the sprint
+ *   - fromSprintTaskHistories: History of tasks removed from the sprint
+ *   - members: Sprint team members with their roles
+ * @returns {ICycleAnalytics} Analytics data containing:
+ *   - assignees: Array of assignee statistics including total, completed and pending issues per assignee
+ *   - labels: Array of label statistics including total, completed and pending issues per label
+ *   - completion_chart: Daily snapshot of remaining incomplete tasks through sprint duration
+ */
+export declare function cycleAnalyticsData(sprint: IOrganizationSprint): ICycleAnalytics;