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

package/dist/modules/comments/comments.service.d.ts

@@ -0,0 +1,92 @@
+import { BaseEntityEnum, IComment, ICommentFindInput, ICreateCommentInput, ICreateReactionInput, ID, IEmployee, IReaction, IReactionData } from '@ever-gauzy/plugin-integration-plane-models';
+import { ApiFetchService } from '../api-fetch/api-fetch.service';
+import { ProjectService } from '../project/project.service';
+import { ReactionsService } from '../reactions/reactions.service';
+export declare class CommentsService extends ApiFetchService {
+    private readonly _projectService;
+    private readonly _reactionService;
+    private readonly _serverFetchService;
+    constructor(_projectService: ProjectService, _reactionService: ReactionsService, _serverFetchService: ApiFetchService);
+    private readonly path;
+    /**
+     * @description Create comment
+     * @param {ICreateCommentInput} input body request for comment creation
+     * @param {BaseEntityEnum} entity commented entity type
+     * @param {ID} entityId commented entity ID
+     * @param {IEmployee[]} employees - Optional mentioned employees
+     * @returns A promise resolved to created comment
+     * @memberof CommentsService
+     */
+    create(input: ICreateCommentInput, entity: BaseEntityEnum, entityId: ID, employees?: IEmployee[]): Promise<IComment>;
+    /**
+     * @description Update comment
+     * @param {ID} id Comment ID to be updated
+     * @param {Partial<ICreateCommentInput>} input Body Request data for updating
+     * @returns A Promise resolved to updated comment
+     * @memberof CommentsService
+     */
+    update(id: ID, options: ICommentFindInput, input: ICreateCommentInput): Promise<IComment>;
+    /**
+     * @description Find comments
+     * @param {Partial<ICommentFindInput>} options Filter options
+     * @returns A promise resolved to fetched comments
+     * @memberof CommentsService
+     */
+    findAll(options: Partial<ICommentFindInput>): Promise<IComment[]>;
+    /**
+     * @description Find one comment
+     * @param {ID} id - Comment ID
+     * @param {ICommentFindInput} options - find filter options
+     * @returns A promise resolved to found comment
+     * @memberof CommentsService
+     */
+    findOne(id: ID, options: ICommentFindInput): Promise<IComment>;
+    /**
+     * @description Delete comment
+     * @param {ID} id - The comment ID to be deleted
+     * @returns A promise resolved to delete result
+     * @memberof CommentsService
+     */
+    delete(id: ID): Promise<any>;
+    /**
+     * @description Create Reaction to comment
+     * @param {ID} entityId - Comment ID for whom create reaction
+     * @param {ID} projectId - The project ID for returning project data
+     * @param {ICreateReactionInput} input - Body request data
+     * @returns A promise resolved to created and transformed reaction
+     * @memberof CommentsService
+     */
+    createReaction(entityId: ID, projectId: ID, input: ICreateReactionInput): Promise<IReactionData>;
+    /**
+     * @description Get comment reaction details
+     * @param {ID} projectId - Project ID
+     * @param {ID} creatorId Creator ID for returning actor details
+     * @returns - A promise resolced afet got details
+     * @memberof CommentsService
+     */
+    getCommentReactionDetails(projectId: ID, creatorId: ID): Promise<{
+        project: import("@ever-gauzy/plugin-integration-plane-models").IOrganizationProject;
+        workspace: {
+            name: string | undefined;
+            id: string | undefined;
+            slug: string;
+        };
+        actor: IEmployee | undefined;
+    }>;
+    /**
+     * @description Find comment reactions with associated data
+     * @param {Partial<IReaction>} options Find options filter
+     * @param {ID} projectId - Project ID for returning data
+     * @returns A promise resolved to found and transformed reactions
+     * @memberof CommentsService
+     */
+    findCommentReactions(options: Partial<IReaction>, projectId: ID): Promise<any>;
+    /**
+     * @description Delete Comment Reaction By Emoji.
+     * @param {string} reaction - Emoji
+     * @param {ID} entityId - Comment ID from whom to delete reaction
+     * @returns A promise resolved to deleted result
+     * @memberof CommentsService
+     */
+    deleteCommentReactionByEmoji(reaction: string, entityId: ID): Promise<any>;
+}

package/dist/modules/comments/comments.service.js

@@ -0,0 +1,235 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsService = void 0;
+const common_1 = require("@nestjs/common");
+const qs_1 = __importDefault(require("qs"));
+const plugin_integration_plane_models_1 = require("@ever-gauzy/plugin-integration-plane-models");
+const api_fetch_service_1 = require("../api-fetch/api-fetch.service");
+const config_1 = require("../../config");
+const project_service_1 = require("../project/project.service");
+const reactions_service_1 = require("../reactions/reactions.service");
+let CommentsService = class CommentsService extends api_fetch_service_1.ApiFetchService {
+    constructor(_projectService, _reactionService, _serverFetchService) {
+        super(_serverFetchService['_httpService']);
+        this._projectService = _projectService;
+        this._reactionService = _reactionService;
+        this._serverFetchService = _serverFetchService;
+        this.path = '/comment';
+    }
+    /**
+     * @description Create comment
+     * @param {ICreateCommentInput} input body request for comment creation
+     * @param {BaseEntityEnum} entity commented entity type
+     * @param {ID} entityId commented entity ID
+     * @param {IEmployee[]} employees - Optional mentioned employees
+     * @returns A promise resolved to created comment
+     * @memberof CommentsService
+     */
+    async create(input, entity, entityId, employees) {
+        var _a, _b;
+        try {
+            const body = (0, config_1.createCommentInputTransformer)(input, entity, entityId, employees);
+            const comment = (await this.apiFetch({
+                method: 'POST',
+                path: this.path,
+                body: Object.assign(Object.assign({}, body), { organizationId: (0, config_1.getCurrentOrganizationSlug)() })
+            })).data;
+            return comment;
+        }
+        catch (error) {
+            this.logger.error(`Operation failed: ${((_b = (_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) || error.message}`, error.stack);
+            throw new common_1.BadRequestException(error);
+        }
+    }
+    /**
+     * @description Update comment
+     * @param {ID} id Comment ID to be updated
+     * @param {Partial<ICreateCommentInput>} input Body Request data for updating
+     * @returns A Promise resolved to updated comment
+     * @memberof CommentsService
+     */
+    async update(id, options, input) {
+        try {
+            const existingComment = await this.findOne(id, options);
+            if (!existingComment) {
+                throw new common_1.BadRequestException('Comment Not Found');
+            }
+            const body = (0, config_1.updateCommentInputTransformer)(input, existingComment);
+            const comment = (await this.apiFetch({
+                method: 'PUT',
+                path: `${this.path}/${id}`,
+                body
+            })).data;
+            return comment;
+        }
+        catch (error) {
+            this.logger.error('Operation failed', error instanceof Error ? error.stack : String(error));
+            throw new common_1.BadRequestException(error);
+        }
+    }
+    /**
+     * @description Find comments
+     * @param {Partial<ICommentFindInput>} options Filter options
+     * @returns A promise resolved to fetched comments
+     * @memberof CommentsService
+     */
+    async findAll(options) {
+        try {
+            const { entity, entityId } = options;
+            const query = qs_1.default.stringify((0, config_1.getCommentsQuery)(entityId, entity));
+            const comments = (await this.apiFetch({ method: 'GET', path: this.path, query })).data;
+            return comments.items;
+        }
+        catch (error) {
+            this.logger.error('Operation failed', error instanceof Error ? error.stack : String(error));
+            throw new common_1.BadRequestException();
+        }
+    }
+    /**
+     * @description Find one comment
+     * @param {ID} id - Comment ID
+     * @param {ICommentFindInput} options - find filter options
+     * @returns A promise resolved to found comment
+     * @memberof CommentsService
+     */
+    async findOne(id, options) {
+        try {
+            const { entity, entityId } = options;
+            const query = qs_1.default.stringify((0, config_1.getCommentsQuery)(entityId, entity));
+            const comment = (await this.apiFetch({
+                method: 'GET',
+                path: `${this.path}/${id}`,
+                query
+            })).data;
+            return comment;
+        }
+        catch (error) {
+            this.logger.error('Operation failed', error instanceof Error ? error.stack : String(error));
+            throw new common_1.BadRequestException();
+        }
+    }
+    /**
+     * @description Delete comment
+     * @param {ID} id - The comment ID to be deleted
+     * @returns A promise resolved to delete result
+     * @memberof CommentsService
+     */
+    async delete(id) {
+        return (await this.apiFetch({
+            method: 'DELETE',
+            path: `${this.path}/${id}`
+        })).data;
+    }
+    /**
+     * @description Create Reaction to comment
+     * @param {ID} entityId - Comment ID for whom create reaction
+     * @param {ID} projectId - The project ID for returning project data
+     * @param {ICreateReactionInput} input - Body request data
+     * @returns A promise resolved to created and transformed reaction
+     * @memberof CommentsService
+     */
+    async createReaction(entityId, projectId, input) {
+        try {
+            // Create reaction
+            const reaction = await this._reactionService.create(input, plugin_integration_plane_models_1.ReactionEntityEnum.Comment, entityId);
+            // Reaction details
+            const { project, workspace } = await this.getCommentReactionDetails(projectId, reaction.employeeId);
+            // Transform Reaction
+            const transformedReaction = (0, config_1.reactionTransformer)(reaction, project, workspace);
+            return Array.isArray(transformedReaction)
+                ? transformedReaction[0]
+                : transformedReaction;
+        }
+        catch (error) {
+            this.logger.error('Operation failed', error instanceof Error ? error.stack : String(error));
+            throw new common_1.BadRequestException(error);
+        }
+    }
+    /**
+     * @description Get comment reaction details
+     * @param {ID} projectId - Project ID
+     * @param {ID} creatorId Creator ID for returning actor details
+     * @returns - A promise resolced afet got details
+     * @memberof CommentsService
+     */
+    async getCommentReactionDetails(projectId, creatorId) {
+        var _a;
+        try {
+            // Find project
+            const project = await this._projectService.getExternalProject(projectId, ['tenant', 'members.employee.user']);
+            // Workspace details
+            const tenant = project.tenant;
+            const workspace = {
+                name: tenant === null || tenant === void 0 ? void 0 : tenant.name,
+                id: tenant === null || tenant === void 0 ? void 0 : tenant.id,
+                slug: tenant.name.toLowerCase()
+            };
+            // Find actor by userId
+            const actor = (_a = project.members.find((member) => member.employee.userId === creatorId)) === null || _a === void 0 ? void 0 : _a.employee;
+            return { project, workspace, actor };
+        }
+        catch (error) {
+            this.logger.error('Operation failed', error instanceof Error ? error.stack : String(error));
+            throw new common_1.BadRequestException(error);
+        }
+    }
+    /**
+     * @description Find comment reactions with associated data
+     * @param {Partial<IReaction>} options Find options filter
+     * @param {ID} projectId - Project ID for returning data
+     * @returns A promise resolved to found and transformed reactions
+     * @memberof CommentsService
+     */
+    async findCommentReactions(options, projectId) {
+        var _a, _b;
+        try {
+            const reactions = await this._reactionService.findAll(options);
+            const commentReactions = await Promise.all(reactions.map(async (reaction) => {
+                const { project, workspace } = await this.getCommentReactionDetails(projectId, reaction.employeeId);
+                const transformedReaction = (0, config_1.reactionTransformer)(reaction, project, workspace);
+                return Array.isArray(transformedReaction)
+                    ? transformedReaction[0]
+                    : transformedReaction;
+            }));
+            return commentReactions;
+        }
+        catch (error) {
+            this.logger.error(`Operation failed: ${((_b = (_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) || error.message}`, error.stack);
+            throw new common_1.BadRequestException(error);
+        }
+    }
+    /**
+     * @description Delete Comment Reaction By Emoji.
+     * @param {string} reaction - Emoji
+     * @param {ID} entityId - Comment ID from whom to delete reaction
+     * @returns A promise resolved to deleted result
+     * @memberof CommentsService
+     */
+    async deleteCommentReactionByEmoji(reaction, entityId) {
+        return await this._reactionService.deleteByEmoji(reaction, plugin_integration_plane_models_1.ReactionEntityEnum.Comment, entityId);
+    }
+};
+exports.CommentsService = CommentsService;
+exports.CommentsService = CommentsService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)((0, common_1.forwardRef)(() => project_service_1.ProjectService))),
+    __metadata("design:paramtypes", [project_service_1.ProjectService,
+        reactions_service_1.ReactionsService,
+        api_fetch_service_1.ApiFetchService])
+], CommentsService);
+//# sourceMappingURL=comments.service.js.map

package/dist/modules/comments/comments.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comments.service.js","sourceRoot":"","sources":["../../../../../../packages/plugin-plane/src/modules/comments/comments.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAKwB;AACxB,4CAAoB;AACpB,iGAYqD;AACrD,sEAAiE;AACjE,yCAMsB;AACtB,gEAA4D;AAC5D,sEAAkE;AAG3D,IAAM,eAAe,GAArB,MAAM,eAAgB,SAAQ,mCAAe;IACnD,YAEC,eAAgD,EAC/B,gBAAkC,EAClC,mBAAoC;QAErD,KAAK,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;QAJ1B,oBAAe,GAAf,eAAe,CAAgB;QAC/B,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,wBAAmB,GAAnB,mBAAmB,CAAiB;QAKrC,SAAI,GAAG,UAAU,CAAC;IAFnC,CAAC;IAID;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACX,KAA0B,EAC1B,MAAsB,EACtB,QAAY,EACZ,SAAuB;;QAEvB,IAAI,CAAC;YACJ,MAAM,IAAI,GAAG,IAAA,sCAA6B,EACzC,KAAK,EACL,MAAM,EACN,QAAQ,EACR,SAAS,CACT,CAAC;YAEF,MAAM,OAAO,GAAa,CACzB,MAAM,IAAI,CAAC,QAAQ,CAAC;gBACnB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,kCACA,IAAI,KACP,cAAc,EAAE,IAAA,mCAA0B,GAAE,GAC5C;aACD,CAAC,CACF,CAAC,IAAI,CAAC;YAEP,OAAO,OAAO,CAAC;QAChB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,qBAAqB,CAAA,MAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,0CAAE,IAAI,0CAAE,OAAO,KAAI,KAAK,CAAC,OAAO,EAAE,EACtE,KAAK,CAAC,KAAK,CACX,CAAC;YACF,MAAM,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACX,EAAM,EACN,OAA0B,EAC1B,KAA0B;QAE1B,IAAI,CAAC;YACJ,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YAExD,IAAI,CAAC,eAAe,EAAE,CAAC;gBACtB,MAAM,IAAI,4BAAmB,CAAC,mBAAmB,CAAC,CAAC;YACpD,CAAC;YAED,MAAM,IAAI,GAAG,IAAA,sCAA6B,EAAC,KAAK,EAAE,eAAe,CAAC,CAAC;YAEnE,MAAM,OAAO,GAAa,CACzB,MAAM,IAAI,CAAC,QAAQ,CAAC;gBACnB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;gBAC1B,IAAI;aACJ,CAAC,CACF,CAAC,IAAI,CAAC;YAEP,OAAO,OAAO,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,kBAAkB,EAClB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACpD,CAAC;YACF,MAAM,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,OAAmC;QAChD,IAAI,CAAC;YACJ,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;YAErC,MAAM,KAAK,GAAG,YAAE,CAAC,SAAS,CAAC,IAAA,yBAAgB,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;YAE/D,MAAM,QAAQ,GAA0B,CACvC,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAC9D,CAAC,IAAI,CAAC;YAEP,OAAO,QAAQ,CAAC,KAAK,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,kBAAkB,EAClB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACpD,CAAC;YACF,MAAM,IAAI,4BAAmB,EAAE,CAAC;QACjC,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,EAAM,EAAE,OAA0B;QAC/C,IAAI,CAAC;YACJ,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;YAErC,MAAM,KAAK,GAAG,YAAE,CAAC,SAAS,CAAC,IAAA,yBAAgB,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;YAE/D,MAAM,OAAO,GAAa,CACzB,MAAM,IAAI,CAAC,QAAQ,CAAC;gBACnB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;gBAC1B,KAAK;aACL,CAAC,CACF,CAAC,IAAI,CAAC;YAEP,OAAO,OAAO,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,kBAAkB,EAClB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACpD,CAAC;YACF,MAAM,IAAI,4BAAmB,EAAE,CAAC;QACjC,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAM;QAClB,OAAO,CACN,MAAM,IAAI,CAAC,QAAQ,CAAC;YACnB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;SAC1B,CAAC,CACF,CAAC,IAAI,CAAC;IACR,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CACnB,QAAY,EACZ,SAAa,EACb,KAA2B;QAE3B,IAAI,CAAC;YACJ,kBAAkB;YAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAClD,KAAK,EACL,oDAAkB,CAAC,OAAO,EAC1B,QAAS,CACT,CAAC;YAEF,mBAAmB;YACpB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAClE,SAAS,EACT,QAAQ,CAAC,UAAW,CACpB,CAAC;YAED,qBAAqB;YACrB,MAAM,mBAAmB,GAAG,IAAA,4BAAmB,EAC9C,QAAQ,EACR,OAAO,EACP,SAAS,CACT,CAAC;YAEF,OAAO,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC;gBACxC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;gBACxB,CAAC,CAAC,mBAAmB,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,kBAAkB,EAClB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACpD,CAAC;YACF,MAAM,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,yBAAyB,CAAC,SAAa,EAAE,SAAa;;QAC3D,IAAI,CAAC;YACJ,eAAe;YACf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAC5D,SAAS,EACT,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CACnC,CAAC;YAEF,oBAAoB;YACpB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,MAAM,SAAS,GAAG;gBACjB,IAAI,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI;gBAClB,EAAE,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE;gBACd,IAAI,EAAE,MAAO,CAAC,IAAK,CAAC,WAAW,EAAE;aACjC,CAAC;YAEF,uBAAuB;YACvB,MAAM,KAAK,GAAG,MAAA,OAAO,CAAC,OAAQ,CAAC,IAAI,CAClC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAS,CAAC,MAAM,KAAK,SAAS,CACjD,0CAAE,QAAQ,CAAC;YAEZ,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,kBAAkB,EAClB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACpD,CAAC;YACF,MAAM,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACzB,OAA2B,EAC3B,SAAa;;QAEb,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAE/D,MAAM,gBAAgB,GAAoB,MAAM,OAAO,CAAC,GAAG,CAC1D,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;gBAChC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAC3B,MAAM,IAAI,CAAC,yBAAyB,CACnC,SAAS,EACT,QAAQ,CAAC,UAAW,CACpB,CAAC;gBAEH,MAAM,mBAAmB,GAAG,IAAA,4BAAmB,EAC9C,QAAQ,EACR,OAAO,EACP,SAAS,CACT,CAAC;gBAEF,OAAO,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC;oBACxC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;oBACxB,CAAC,CAAC,mBAAmB,CAAC;YACxB,CAAC,CAAC,CACF,CAAC;YAEF,OAAO,gBAAgB,CAAC;QACzB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,KAAK,CAChB,qBAAqB,CAAA,MAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,0CAAE,IAAI,0CAAE,OAAO,KAAI,KAAK,CAAC,OAAO,EAAE,EACtE,KAAK,CAAC,KAAK,CACX,CAAC;YACF,MAAM,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,4BAA4B,CACjC,QAAgB,EAChB,QAAY;QAEZ,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAC/C,QAAQ,EACR,oDAAkB,CAAC,OAAO,EAC1B,QAAQ,CACR,CAAC;IACH,CAAC;CACD,CAAA;AAxTY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,mBAAU,GAAE;IAGV,WAAA,IAAA,eAAM,EAAC,IAAA,mBAAU,EAAC,GAAG,EAAE,CAAC,gCAAc,CAAC,CAAC,CAAA;qCACP,gCAAc;QACb,oCAAgB;QACb,mCAAe;GAL1C,eAAe,CAwT3B"}

package/dist/modules/cycles/cycles.controller.d.ts

@@ -0,0 +1,106 @@
+import { ICycle, ICycleAnalytics, ICycleIssuesResponse, ICycleProgress, ID } from '@ever-gauzy/plugin-integration-plane-models';
+import { CyclesService } from './cycles.service';
+import { CreateCycleDTO, CycleDTO, UpdateCycleDTO } from './dto';
+export declare class CyclesController {
+    private readonly _cycleService;
+    constructor(_cycleService: CyclesService);
+    /**
+     * Creates a new cycle (sprint) based on the provided input.
+     *
+     * @param {CreateCycleDTO} input - The data transfer object containing the cycle details to create.
+     * @returns {Promise<ICycle | ICycle[]>} - The newly created cycle or a list of cycles after the creation.
+     */
+    create(input: CreateCycleDTO): Promise<ICycle | ICycle[]>;
+    /**
+     * Checks for overlaps with existing cycles before creating a new cycle.
+     *
+     * @param input The start and end dates for the new cycle to be created.
+     * @returns The status and optional error according to overlaps existing
+     */
+    checkDatesOverlap(input: Pick<CycleDTO, 'start_date' | 'end_date'>): Promise<{
+        error: string;
+        status: boolean;
+    } | {
+        status: boolean;
+        error?: undefined;
+    }>;
+    /**
+     * Adds a list of issues to a sprint by updating each issue with the given cycle ID.
+     *
+     * @param {ID} id - The ID of the sprint (cycle) to which the issues will be added.
+     * @param {ID[]} input - An array of issue IDs that need to be associated with the sprint.
+     * @returns {Promise<{ message: string }>} A success message upon completion.
+     */
+    addIssuesToSprint(id: ID, input: {
+        issues: ID[];
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Removes an issue from a sprint by updating the issue with the given cycle ID to null.
+     *
+     * @param {ID} issueId - The ID of the issue to be removed from the sprint.
+     * @returns A promise that resolves to the updated issue.
+     */
+    removeIssueFromSprint(issueId: ID): Promise<import("@ever-gauzy/plugin-integration-plane-models").IIssue>;
+    /**
+     * Updates an existing cycle (sprint) based on the provided ID and input data.
+     *
+     * @param {ID} id - The unique identifier of the cycle to update.
+     * @param {UpdateCycleDTO} input - The data transfer object containing the updated cycle details.
+     * @returns {Promise<ICycle | ICycle[]>} - The updated cycle or a list of updated cycles after the update.
+     */
+    update(id: ID, input: UpdateCycleDTO): Promise<ICycle | ICycle[]>;
+    /**
+     * Retrieves all cycles (sprints) for a given project.
+     *
+     * @param {ID} projectId - The unique identifier of the project to filter cycles.
+     * @returns {Promise<ICycle | ICycle[]>} - A promise that resolves to a list of cycles for the specified project.
+     */
+    findAll(projectId: ID): Promise<ICycle | ICycle[]>;
+    /**
+     * Retrieves a specific cycle (sprint) by its ID and optionally filters by project ID.
+     *
+     * @param {ID} id - The unique identifier of the cycle to retrieve.
+     * @param {ID} projectId - (Optional) The unique identifier of the project to filter the cycle.
+     * @returns {Promise<ICycle | ICycle[]>} - A promise that resolves to the requested cycle or a list of cycles.
+     */
+    findOne(id: ID, projectId: ID): Promise<ICycle | ICycle[]>;
+    /**
+     * Retrieves all tasks that were ever part of a sprint
+     *
+     * @param {ID} id - The ID of the sprint (cycle).
+     * @param {ID} projectId - The ID of the project to which the sprint belongs.
+     * @returns {Promise<ICycleIssuesResponse>} - A transformed response containing all unique sprint issues.
+     */
+    findCycleIssues(id: ID, projectId: ID): Promise<ICycleIssuesResponse>;
+    /**
+     * Retrieves analytics data for a specific cycle within a project.
+     *
+     * This function fetches the cycle/sprint data along with its associated tasks and task histories.
+     * It analyzes tasks to provide statistics about task completion, assignments, and labels.
+     *
+     * @param {ID} id - The ID of the cycle to analyze
+     * @param {ID} projectId - The ID of the project containing the cycle
+     * @returns {Promise<any>} A promise that resolves to the cycle analytics data.
+     */
+    findCycleAnalytics(id: ID, projectId: ID): Promise<ICycleAnalytics>;
+    /**
+     * Retrieves the progress of a specific cycle within a project, including task counts
+     * and estimation points for various statuses (e.g., backlog, started, completed).
+     *
+     * @param {ID} id - The unique identifier of the cycle to retrieve progress for.
+     * @param {ID} projectId - The unique identifier of the project the cycle belongs to.
+     * @returns {Promise<ICycleProgress>} - A promise that resolves to an object containing
+     *   detailed cycle progress, including task counts and estimation points.
+     */
+    getCycleProgress(id: ID, projectId: ID): Promise<ICycleProgress>;
+    findCycleUserProperties(id: ID): Promise<any>;
+    updateModuleUserProperties(id: ID, input: any): Promise<import("@ever-gauzy/plugin-integration-plane-models").IUserViewProperties>;
+    /** Deletes a specific cycle (sprint) by its ID.
+     *
+     * @param {ID} id - The unique identifier of the cycle to delete.
+     * @returns - A promise that resolves when the cycle is successfully deleted.
+     */
+    delete(id: ID): Promise<any>;
+}