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

package/dist/modules/cycles/cycles.controller.js

@@ -0,0 +1,270 @@
+"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); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CyclesController = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const common_1 = require("@nestjs/common");
+const cycles_service_1 = require("./cycles.service");
+const dto_1 = require("./dto");
+let CyclesController = class CyclesController {
+    constructor(_cycleService) {
+        this._cycleService = _cycleService;
+    }
+    /**
+     * 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.
+     */
+    async create(input) {
+        return await this._cycleService.create(input);
+    }
+    /**
+     * 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
+     */
+    async checkDatesOverlap(input) {
+        return await this._cycleService.checkDatesOverlap(input);
+    }
+    /**
+     * 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.
+     */
+    async addIssuesToSprint(id, input) {
+        return await this._cycleService.addIssuesToSprint(id, input);
+    }
+    /**
+     * 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.
+     */
+    async removeIssueFromSprint(issueId) {
+        return await this._cycleService.removeIssueFromSprint(issueId);
+    }
+    /**
+     * 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.
+     */
+    async update(id, input) {
+        return await this._cycleService.update(id, input);
+    }
+    /**
+     * 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.
+     */
+    async findAll(projectId) {
+        return this._cycleService.findAll(projectId);
+    }
+    /**
+     * 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.
+     */
+    async findOne(id, projectId) {
+        return this._cycleService.findOne(id, projectId);
+    }
+    /**
+     * 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.
+     */
+    async findCycleIssues(id, projectId) {
+        return this._cycleService.findCycleIssues(id, projectId);
+    }
+    /**
+     * 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.
+     */
+    async findCycleAnalytics(id, projectId) {
+        return this._cycleService.findCycleAnalytics(id, projectId);
+    }
+    /**
+     * 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.
+     */
+    async getCycleProgress(id, projectId) {
+        return this._cycleService.getCycleProgress(id, projectId);
+    }
+    async findCycleUserProperties(id) {
+        return this._cycleService.findCycleUserProperties(id);
+    }
+    async updateModuleUserProperties(id, input) {
+        return this._cycleService.updateCycleUserProperties(id, input);
+    }
+    /** 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.
+     */
+    async delete(id) {
+        return await this._cycleService.delete(id);
+    }
+};
+exports.CyclesController = CyclesController;
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.CREATED),
+    (0, swagger_1.ApiOperation)({ summary: 'Create Cycle' }),
+    (0, common_1.Post)(),
+    __param(0, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [dto_1.CreateCycleDTO]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "create", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Check Data Overlaps' }),
+    (0, common_1.Post)('/date-check'),
+    __param(0, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "checkDatesOverlap", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.CREATED),
+    (0, swagger_1.ApiOperation)({ summary: 'Add Issue to Cycle' }),
+    (0, common_1.Post)('/:id/cycle-issues'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "addIssuesToSprint", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Remove Issue from Cycle' }),
+    (0, common_1.Delete)('/:id/cycle-issues/:issueId'),
+    __param(0, (0, common_1.Param)('issueId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "removeIssueFromSprint", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Update Cycle' }),
+    (0, common_1.Patch)(':id'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, dto_1.UpdateCycleDTO]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "update", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Get Cycles' }),
+    (0, common_1.Get)(),
+    __param(0, (0, common_1.Param)('projectId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "findAll", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Get Cycle' }),
+    (0, common_1.Get)(':id'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Param)('projectId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "findOne", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Get Cycle Issues' }),
+    (0, common_1.Get)(':id/cycle-issues'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Param)('projectId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "findCycleIssues", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Get Cycle Issues' }),
+    (0, common_1.Get)(':id/analytics'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Param)('projectId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "findCycleAnalytics", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Get Cycle Issues' }),
+    (0, common_1.Get)(':id/progress'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Param)('projectId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "getCycleProgress", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    (0, swagger_1.ApiOperation)({ summary: 'Get Cycle User properties' }),
+    (0, common_1.Get)(':id/user-properties'),
+    __param(0, (0, common_1.Param)('id')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "findCycleUserProperties", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.CREATED),
+    (0, swagger_1.ApiOperation)({ summary: 'Update Cycle User properties' }),
+    (0, common_1.Patch)(':id/user-properties'),
+    __param(0, (0, common_1.Param)('id')),
+    __param(1, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "updateModuleUserProperties", null);
+__decorate([
+    (0, common_1.HttpCode)(common_1.HttpStatus.NO_CONTENT),
+    (0, swagger_1.ApiOperation)({ summary: 'Delete Cycle' }),
+    (0, common_1.Delete)(':id'),
+    __param(0, (0, common_1.Param)('id')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], CyclesController.prototype, "delete", null);
+exports.CyclesController = CyclesController = __decorate([
+    (0, swagger_1.ApiTags)('Cycles'),
+    (0, common_1.Controller)(),
+    __metadata("design:paramtypes", [cycles_service_1.CyclesService])
+], CyclesController);
+//# sourceMappingURL=cycles.controller.js.map

package/dist/modules/cycles/cycles.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cycles.controller.js","sourceRoot":"","sources":["../../../../../../packages/plugin-plane/src/modules/cycles/cycles.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,6CAAwD;AACxD,2CAUwB;AAQxB,qDAAiD;AACjD,+BAAiE;AAI1D,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAC5B,YAA6B,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;IAAG,CAAC;IAE7D;;;;;OAKG;IAIG,AAAN,KAAK,CAAC,MAAM,CAAS,KAAqB;QACzC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IAIG,AAAN,KAAK,CAAC,iBAAiB,CACd,KAAgD;QAExD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IAIG,AAAN,KAAK,CAAC,iBAAiB,CACT,EAAM,EACX,KAAuB;QAE/B,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IAIG,AAAN,KAAK,CAAC,qBAAqB,CAAmB,OAAW;QACxD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IAIG,AAAN,KAAK,CAAC,MAAM,CACE,EAAM,EACX,KAAqB;QAE7B,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IAIG,AAAN,KAAK,CAAC,OAAO,CACQ,SAAa;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IAIG,AAAN,KAAK,CAAC,OAAO,CACC,EAAM,EACC,SAAa;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IAIG,AAAN,KAAK,CAAC,eAAe,CACP,EAAM,EACC,SAAa;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IAIG,AAAN,KAAK,CAAC,kBAAkB,CACV,EAAM,EACC,SAAa;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IAIG,AAAN,KAAK,CAAC,gBAAgB,CACR,EAAM,EACC,SAAa;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAKK,AAAN,KAAK,CAAC,uBAAuB,CAAc,EAAM;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC;IAKK,AAAN,KAAK,CAAC,0BAA0B,CAAc,EAAM,EAAU,KAAU;QACvE,OAAO,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IAIG,AAAN,KAAK,CAAC,MAAM,CAAc,EAAM;QAC/B,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC;CACD,CAAA;AA/LY,4CAAgB;AAYtB;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,OAAO,CAAC;IAC5B,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IACzC,IAAA,aAAI,GAAE;IACO,WAAA,IAAA,aAAI,GAAE,CAAA;;qCAAQ,oBAAc;;8CAEzC;AAWK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC;IAChD,IAAA,aAAI,EAAC,aAAa,CAAC;IAElB,WAAA,IAAA,aAAI,GAAE,CAAA;;;;yDAGP;AAYK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,OAAO,CAAC;IAC5B,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAC/C,IAAA,aAAI,EAAC,mBAAmB,CAAC;IAExB,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IACX,WAAA,IAAA,aAAI,GAAE,CAAA;;;;yDAGP;AAWK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACpD,IAAA,eAAM,EAAC,4BAA4B,CAAC;IACR,WAAA,IAAA,cAAK,EAAC,SAAS,CAAC,CAAA;;;;6DAE5C;AAYK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IACzC,IAAA,cAAK,EAAC,KAAK,CAAC;IAEX,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IACX,WAAA,IAAA,aAAI,GAAE,CAAA;;6CAAQ,oBAAc;;8CAG7B;AAWK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;IACvC,IAAA,YAAG,GAAE;IAEJ,WAAA,IAAA,cAAK,EAAC,WAAW,CAAC,CAAA;;;;+CAGnB;AAYK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;IACtC,IAAA,YAAG,EAAC,KAAK,CAAC;IAET,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IACX,WAAA,IAAA,cAAK,EAAC,WAAW,CAAC,CAAA;;;;+CAGnB;AAYK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC7C,IAAA,YAAG,EAAC,kBAAkB,CAAC;IAEtB,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IACX,WAAA,IAAA,cAAK,EAAC,WAAW,CAAC,CAAA;;;;uDAGnB;AAeK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC7C,IAAA,YAAG,EAAC,eAAe,CAAC;IAEnB,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IACX,WAAA,IAAA,cAAK,EAAC,WAAW,CAAC,CAAA;;;;0DAGnB;AAcK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC7C,IAAA,YAAG,EAAC,cAAc,CAAC;IAElB,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IACX,WAAA,IAAA,cAAK,EAAC,WAAW,CAAC,CAAA;;;;wDAGnB;AAKK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACvB,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC;IACtD,IAAA,YAAG,EAAC,qBAAqB,CAAC;IACI,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;;;;+DAEzC;AAKK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,OAAO,CAAC;IAC5B,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;IACzD,IAAA,cAAK,EAAC,qBAAqB,CAAC;IACK,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;IAAU,WAAA,IAAA,aAAI,GAAE,CAAA;;;;kEAE5D;AAUK;IAHL,IAAA,iBAAQ,EAAC,mBAAU,CAAC,UAAU,CAAC;IAC/B,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IACzC,IAAA,eAAM,EAAC,KAAK,CAAC;IACA,WAAA,IAAA,cAAK,EAAC,IAAI,CAAC,CAAA;;;;8CAExB;2BA9LW,gBAAgB;IAF5B,IAAA,iBAAO,EAAC,QAAQ,CAAC;IACjB,IAAA,mBAAU,GAAE;qCAEgC,8BAAa;GAD7C,gBAAgB,CA+L5B"}

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

@@ -0,0 +1,2 @@
+export declare class CyclesModule {
+}

package/dist/modules/cycles/cycles.module.js

@@ -0,0 +1,31 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CyclesModule = void 0;
+const common_1 = require("@nestjs/common");
+const cycles_service_1 = require("./cycles.service");
+const cycles_controller_1 = require("./cycles.controller");
+const project_module_1 = require("../project/project.module");
+const issues_module_1 = require("../issues/issues.module");
+const employee_properties_module_1 = require("../employee-properties/employee-properties.module");
+let CyclesModule = class CyclesModule {
+};
+exports.CyclesModule = CyclesModule;
+exports.CyclesModule = CyclesModule = __decorate([
+    (0, common_1.Module)({
+        imports: [
+            (0, common_1.forwardRef)(() => project_module_1.ProjectModule),
+            issues_module_1.IssuesModule,
+            employee_properties_module_1.EmployeePropertiesModule
+        ],
+        providers: [cycles_service_1.CyclesService],
+        controllers: [cycles_controller_1.CyclesController],
+        exports: [cycles_service_1.CyclesService]
+    })
+], CyclesModule);
+//# sourceMappingURL=cycles.module.js.map

package/dist/modules/cycles/cycles.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cycles.module.js","sourceRoot":"","sources":["../../../../../../packages/plugin-plane/src/modules/cycles/cycles.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAoD;AACpD,qDAAiD;AACjD,2DAAuD;AACvD,8DAA0D;AAC1D,2DAAuD;AACvD,kGAA6F;AAYtF,IAAM,YAAY,GAAlB,MAAM,YAAY;CAAG,CAAA;AAAf,oCAAY;uBAAZ,YAAY;IAVxB,IAAA,eAAM,EAAC;QACP,OAAO,EAAE;YACR,IAAA,mBAAU,EAAC,GAAG,EAAE,CAAC,8BAAa,CAAC;YAC/B,4BAAY;YACZ,qDAAwB;SACxB;QACD,SAAS,EAAE,CAAC,8BAAa,CAAC;QAC1B,WAAW,EAAE,CAAC,oCAAgB,CAAC;QAC/B,OAAO,EAAE,CAAC,8BAAa,CAAC;KACxB,CAAC;GACW,YAAY,CAAG"}

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

@@ -0,0 +1,169 @@
+import { ICycle, ICycleAnalytics, ICycleIssuesResponse, ICycleProgress, ID, IOrganizationSprint, IUpdateUserPropertiesInput, IUserViewProperties } from '@ever-gauzy/plugin-integration-plane-models';
+import { ApiFetchService } from '../api-fetch/api-fetch.service';
+import { UserFavoritesService } from '../user-favorites/user-favorites.service';
+import { IssuesService } from '../issues/issues.service';
+import { EmployeePropertiesService } from '../employee-properties/employee-properties.service';
+export declare class CyclesService extends ApiFetchService {
+    private readonly _serverFetchService;
+    private readonly _issueService;
+    private readonly _userFavoriteService;
+    private readonly _employeePropertiesService;
+    constructor(_serverFetchService: ApiFetchService, _issueService: IssuesService, _userFavoriteService: UserFavoritesService, _employeePropertiesService: EmployeePropertiesService);
+    private readonly path;
+    /**
+     * @description Find a sprint from external API
+     * @param {ID} id - The sprint ID to find
+     * @param {ID} [projectId] - Optional Project ID to filter search
+     * @returns {Promise<IOrganizationSprint>} - A promise resolved to found Sprint
+     * @memberof CyclesService
+     */
+    getExternalSprint(id: ID, projectId?: ID, relations?: string[]): Promise<IOrganizationSprint>;
+    /**
+     * Creates a new cycle and returns the transformed cycle or cycles.
+     *
+     * @param {ICycle} input - The cycle data used to create a new cycle.
+     * @returns {Promise<ICycle | ICycle[]>} - The created cycle or a list of cycles after transformation.
+     * @throws {BadRequestException} - Throws an error if the creation fails.
+     */
+    create(input: ICycle): Promise<ICycle | ICycle[]>;
+    /**
+     * Updates an existing cycle by its ID and returns the transformed cycle or cycles.
+     *
+     * @param {ID} id - The unique identifier of the cycle to update.
+     * @param {ICycle} input - The updated cycle data.
+     * @returns {Promise<ICycle | ICycle[]>} - The updated cycle or a list of updated cycles after transformation.
+     * @throws {BadRequestException} - Throws an error if the update fails.
+     */
+    update(id: ID, input: Partial<Omit<ICycle, 'id'>>): Promise<ICycle | ICycle[]>;
+    /**
+     * Retrieves all cycles (sprints) optionally filtered by a project ID and returns the transformed result.
+     *
+     * @param {ID} [projectId] - Optional project ID to filter the cycles by project.
+     * @returns {Promise<ICycle | ICycle[]>} - A list of cycles or a single cycle after transformation.
+     * @throws {BadRequestException} - Throws an error if the fetching process fails.
+     */
+    findAll(projectId?: ID): Promise<ICycle | ICycle[]>;
+    /**
+     * Retrieves a specific cycle (sprint) by its ID, optionally filtered by project ID, and returns the transformed result.
+     *
+     * @param {ID} [id] - The unique identifier of the cycle to retrieve.
+     * @param {ID} [projectId] - Optional project ID to further filter the cycle.
+     * @returns {Promise<ICycle | ICycle[]>} - The retrieved cycle or a list of cycles after transformation.
+     * @throws {BadRequestException} - Throws an error if the retrieval process fails.
+     */
+    findOne(id?: ID, projectId?: ID): Promise<ICycle | ICycle[]>;
+    /**
+     * Adds a list of issues to a sprint by updating each issue with the given cycle ID.
+     * Utilizes `Promise.all` to perform asynchronous updates on multiple issues concurrently.
+     *
+     * @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.
+     * @throws {BadRequestException} If there is an error during the update of any issue.
+     */
+    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 promise that resolves to the updated issue.
+     * @throws {BadRequestException} If there is an error during the update of the issue.
+     */
+    removeIssueFromSprint(issueId: ID): Promise<import("@ever-gauzy/plugin-integration-plane-models").IIssue>;
+    /**
+     * Retrieves all tasks that were ever part of a sprint (current and previous).
+     * This method combines current and previous sprint tasks, ensuring no duplicates.
+     *
+     * @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.
+     * @throws {NotFoundException} - If the sprint is not found.
+     * @throws {BadRequestException} - For other errors, with the error response passed in the exception.
+     */
+    findCycleIssues(id: ID, projectId: ID): Promise<ICycleIssuesResponse>;
+    /**
+     * 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<ICycle, 'start_date' | 'end_date'>, projectId?: ID): Promise<{
+        error: string;
+        status: boolean;
+    } | {
+        status: boolean;
+        error?: undefined;
+    }>;
+    /**
+     * Deletes a specific cycle (sprint) by its ID.
+     *
+     * @param {ID} id - The unique identifier of the cycle to delete.
+     * @returns {Promise<any>} - The response data from the delete operation.
+     * @throws {BadRequestException} - Throws an error if the deletion process fails.
+     */
+    delete(id: ID): Promise<any>;
+    /**
+     * Checks for date overlaps between existing cycles and the new dates.
+     * Uses `moment` for more precise date comparisons.
+     * @param cycles The existing cycles.
+     * @param startDate The start date of the new cycle.
+     * @param endDate The end date of the new cycle.
+     * @returns true if there is an overlap, otherwise false.
+     */
+    private checkForDateOverlap;
+    /**
+     * Finds or creates cycle user properties for a specific cycle (sprint).
+     *
+     * If the user's settings for the given cycle are not found, it will attempt
+     * to create a new one with default properties.
+     *
+     * @param {ID} id - The identifier of the cycle (sprint).
+     * @returns {Promise<any>} Serialized user setting for the cycle.
+     * @throws {BadRequestException} Throws if the operation fails.
+     */
+    findCycleUserProperties(id: ID): Promise<any>;
+    /**
+     * Updates or creates cycle user properties for a specific cycle (sprint).
+     *
+     * If the user's settings for the given cycle already exist, they will be updated.
+     * Otherwise, new settings will be created with default properties.
+     *
+     * @param {ID} id - The identifier of the cycle (sprint).
+     * @param {IUpdateUserPropertiesInput} input - The updated properties input.
+     * @returns {Promise<IUserViewProperties>} The updated or newly created user properties.
+     * @throws {BadRequestException} Throws if the operation fails.
+     */
+    updateCycleUserProperties(id: ID, input: IUpdateUserPropertiesInput): Promise<IUserViewProperties>;
+    /**
+     * 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} cycleId - 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 including:
+     *   - Task completion statistics
+     *   - Assignment distribution
+     *   - Label distribution
+     * @throws {BadRequestException} If there is an error fetching or processing the data
+     */
+    findCycleAnalytics(cycleId: 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} cycleId - 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.
+     *
+     * @throws {BadRequestException} - Throws an exception if the external sprint cannot
+     *   be retrieved or any error occurs during the process.
+     */
+    getCycleProgress(cycleId: ID, projectId: ID): Promise<ICycleProgress>;
+}