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

package/dist/modules/workspace/workspace-context.service.js

@@ -0,0 +1,35 @@
+"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 WorkspaceContextService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceContextService = void 0;
+const common_1 = require("@nestjs/common");
+let WorkspaceContextService = WorkspaceContextService_1 = class WorkspaceContextService {
+    /**
+     * @description Set the current workspace slug
+     * @param {string} slug - The workspace slug
+     */
+    static setWorkspaceSlug(slug) {
+        WorkspaceContextService_1.workspaceSlug = slug;
+    }
+    /**
+     * @description Get the current workspace slug
+     * @returns {string} The current workspace slug
+     */
+    static getCurrentWorkspaceSlug() {
+        if (!WorkspaceContextService_1.workspaceSlug) {
+            return '';
+        }
+        return WorkspaceContextService_1.workspaceSlug;
+    }
+};
+exports.WorkspaceContextService = WorkspaceContextService;
+exports.WorkspaceContextService = WorkspaceContextService = WorkspaceContextService_1 = __decorate([
+    (0, common_1.Injectable)()
+], WorkspaceContextService);
+//# sourceMappingURL=workspace-context.service.js.map

package/dist/modules/workspace/workspace-context.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-context.service.js","sourceRoot":"","sources":["../../../../../../packages/plugin-plane/src/modules/workspace/workspace-context.service.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA4C;AAGrC,IAAM,uBAAuB,+BAA7B,MAAM,uBAAuB;IAGnC;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACnC,yBAAuB,CAAC,aAAa,GAAG,IAAI,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,uBAAuB;QAC7B,IAAI,CAAC,yBAAuB,CAAC,aAAa,EAAE,CAAC;YAC5C,OAAO,EAAE,CAAC;QACX,CAAC;QACD,OAAO,yBAAuB,CAAC,aAAa,CAAC;IAC9C,CAAC;CACD,CAAA;AArBY,0DAAuB;kCAAvB,uBAAuB;IADnC,IAAA,mBAAU,GAAE;GACA,uBAAuB,CAqBnC"}

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

@@ -0,0 +1,292 @@
+import { WorkspaceService } from './workspace.service';
+import { DashboardIssueTypeEnum, DashboardWigetQueryEnum, ICreateIssueLink, ICycle, ID, IEntitySearchFindInput, IGlabalEntitiesFindInput, IIssue, IIssueFindInput, IIssueLabel, IModule, INotification, IUserStatsResponse } from '@ever-gauzy/plugin-integration-plane-models';
+import { CreateIssueDTO, UpdateIssueDTO } from '../issues/dto';
+export declare class WorkspaceController {
+    private readonly _workspaceService;
+    constructor(_workspaceService: WorkspaceService);
+    /**
+     * @description - Get dashboard widgets for given workspace
+     * @param {string} dashboard_type - query that define which widget filter should be fetched
+     * @returns - A promise that resolves when dashboard widgets are fetched
+     * @memberof WorkspaceController
+     */
+    getDashboard(dashboard_type: string): Promise<{
+        dashboard: import("@ever-gauzy/plugin-integration-plane-models").IHomeDashboard;
+        widgets: import("@ever-gauzy/plugin-integration-plane-models").IWidget | import("@ever-gauzy/plugin-integration-plane-models").IWidget[];
+    }>;
+    getWigetsData(widget: DashboardWigetQueryEnum, target_date: string, issue_type: DashboardIssueTypeEnum): Promise<any>;
+    /**
+     * Retrieves the default set of dashboard widgets for the home preferences.
+     *
+     * @returns An array of widget objects, each containing a key,
+     * is_enabled status, config, and sort_order. These widgets represent
+     * the default settings for the home dashboard.
+     */
+    getWidgets(): Promise<{
+        key: string;
+        is_enabled: boolean;
+        config: {};
+        sort_order: number;
+    }[]>;
+    /**
+     * @description - Get member (from connected user) info for a workspace
+     * @returns - A promise that resolves after getting member informations
+     * @memberof WorkspaceController
+     */
+    getMembersMe(): Promise<{
+        id: string | null;
+        created_at: Date | undefined;
+        updated_at: Date | undefined;
+        deleted_at: Date | undefined;
+        role: number;
+        company_role: string;
+        view_props: {
+            id: ID;
+            created_at?: Date;
+            updated_at?: Date;
+            deleted_at?: Date;
+            created_by?: ID;
+            updated_by?: ID;
+            project?: ID;
+            module?: ID;
+            cycle?: ID;
+            workspace?: ID;
+            user?: ID;
+            rich_filters?: import("@ever-gauzy/plugin-integration-plane-models").IViewPropsFilters;
+            filters?: import("@ever-gauzy/plugin-integration-plane-models").IViewPropsFilters;
+            display_filters?: import("@ever-gauzy/plugin-integration-plane-models").IViewPropsDisplayFilters;
+            display_properties?: import("@ever-gauzy/plugin-integration-plane-models").IDisplayProperties;
+        };
+        default_props: {
+            filters: any;
+            display_filters: any;
+            display_properties: any;
+        };
+        issue_props: any;
+        is_active: boolean;
+        created_by: string;
+        updated_by: string;
+        workspace: string | undefined;
+        user_info: {
+            id: string | undefined;
+            first_name: string;
+            last_name: string;
+            avatar: string | undefined;
+            is_bot: boolean;
+            display_name: string;
+            email: string | undefined;
+        };
+        workspace_info: {
+            id: string | undefined;
+            slug: string | undefined;
+            name: string;
+        };
+        member: string;
+    }>;
+    /**
+     * @description - Get members for a workspace
+     * @returns - A promise that resolves after getting members for a workspace
+     * @memberof WorkspaceController
+     */
+    getMembers(): Promise<import("@ever-gauzy/plugin-integration-plane-models").IWorkspaceUserInfo[]>;
+    /**
+     * Retrieves a summary of the user's work statistics, including task distribution
+     * by state and priority, as well as counts for created, assigned, and completed issues.
+     *
+     * @returns {Promise<IUserStatsResponse>} A promise that resolves with the user's work summary.
+     *
+     */
+    findUserWorkSummary(employeeId: ID): Promise<IUserStatsResponse>;
+    /**
+     * Retrieves the user's recent activity
+     *
+     * @returns {Promise<Object>} A promise that resolves with a structured response containing user activity details.
+     */
+    findUserRecentActivity(employeeId: ID, per_page: number): Promise<any>;
+    /**
+     * Retrieves the project data associated with the currently connected user.
+     *
+     * @returns {Promise<IUserProjectsDataResponse>} A promise that resolves with the user's projects data.
+     *
+     */
+    findUserProjectsData(employeeId: ID): Promise<any>;
+    /**
+     * Retrieves and groups issues assigned to a user based on the specified grouping option.
+     *
+     * @param {IIssueFindInput} options - The input options specifying the query criteria.
+     * @returns A promise that resolves to an array of grouped issues.
+     */
+    findUserGroupedIssueAssigned(options: IIssueFindInput): Promise<any>;
+    /**
+     * Fetches all projects associated with the workspace.
+     *
+     * @returns A promise resolving to an array of workspace projects.
+     */
+    findWorkspaceProjects(): Promise<any>;
+    /**
+     * Fetches all workspace states associated with projects in the workspace.
+     *
+     * @returns A promise resolving to an array of workspace states.
+     */
+    findWorkspaceStates(): Promise<any>;
+    /**
+     * Fetches all workspace modules associated with projects in the workspace.
+     *
+     * @returns {Promise<IModule[]>} A promise resolving to an array of project modules.
+     */
+    findWorkspaceModules(): Promise<IModule[]>;
+    /**
+     * Fetches all cycles associated with projects in the workspace.
+     *
+     * @returns {Promise<ICycle[]>} A promise resolving to an array of cycles.
+     *
+     */
+    findWorkspaceCycles(): Promise<ICycle[]>;
+    /**
+     * Retrieves all labels associated with the projects in the workspace.
+     *
+     * @returns {Promise<IIssueLabel[]>} A promise resolving to an array of issue labels.
+     */
+    findWorkspaceLabels(): Promise<IIssueLabel[]>;
+    /**
+     * Creates a new draft issue.
+     * @param {CreateIssueDTO} input - The input data required to create a draft issue.
+     * @returns {Promise<IIssue>} A promise that resolves to the newly created draft issue.
+     */
+    createDraftIssue(input: CreateIssueDTO): Promise<IIssue>;
+    /**
+     * Updates an issue with the given ID and input data, ensuring it remains a draft.
+     *
+     * @param {ID} id - The unique identifier of the issue to update.
+     * @param {IIssueUpdateInput} input - The data to update the issue with.
+     * @returns {Promise<IIssue>} A promise that resolves to the updated issue.
+     */
+    update(input: UpdateIssueDTO, id: ID): Promise<IIssue>;
+    /**
+     * Retrieves all draft issues.
+     *
+     * @returns {Promise<any>} A promise that resolves to a list of transformed issues.
+     */
+    findDraftIssues(): Promise<any>;
+    draftToIssue(input: UpdateIssueDTO, id: ID): Promise<IIssue>;
+    /**
+     * @description - Find global entities (Projects, issues, etc.)
+     * @param {IGlabalEntitiesFindInput} options - query that define the filter options
+     * @returns - A promise that resolves when entities are found
+     */
+    findGlobalEntitiesBySearch(options: IGlabalEntitiesFindInput): Promise<import("@ever-gauzy/plugin-integration-plane-models").IGlobalEntitiesResponse>;
+    /**
+     * Performs an entity search based on the provided options.
+     *
+     * @param {IEntitySearchFindInput} options - The search options containing `project_id`
+     * and `query_type`.
+     * @returns {Promise<any>} A promise resolving to an object containing the user mention details.
+     */
+    entitySearch(options: IEntitySearchFindInput): Promise<any>;
+    /**
+     * @description - Find workspace issues by view type.
+     * @param {IIssueFindInput} options - query that define the filter options.
+     * @param {string} referer - Request referer to determine view ID.
+     * @returns - A promise that resolves when entities are found
+     */
+    findViewIssues(options: IIssueFindInput, referer: string): Promise<any>;
+    findMyNotifications(): Promise<import("@ever-gauzy/plugin-integration-plane-models").INotificationResponse>;
+    findMyUnreadNotifications(): Promise<import("@ever-gauzy/plugin-integration-plane-models").IUnreadNotificationResponse>;
+    markAllAsRead(): Promise<any>;
+    readNotification(id: ID): Promise<INotification>;
+    unreadNotification(id: ID): Promise<INotification>;
+    archiveNotification(id: ID): Promise<any>;
+    unArchiveNotification(id: ID): Promise<any>;
+    holdNotification(id: ID, data: INotification): Promise<any>;
+    getCurrentPlan(): Promise<{
+        is_cancelled: boolean;
+        purchased_seats: number;
+        current_period_end_date: string;
+        interval: string;
+        product: string;
+        is_offline_payment: boolean;
+        trial_end_date: string;
+        has_activated_free_trial: boolean;
+        has_added_payment_method: boolean;
+        subscription: string;
+        is_self_managed: boolean;
+        is_on_trial: boolean;
+        is_trial_allowed: boolean;
+        remaining_trial_days: number;
+        has_upgraded: boolean;
+        show_payment_button: boolean;
+        show_trial_banner: boolean;
+        free_seats: number;
+        occupied_seats: number;
+        show_seats_banner: boolean;
+        current_period_start_date: string;
+        is_trial_ended: boolean;
+        billable_members: number;
+        is_free_member_count_exceeded: boolean;
+    }>;
+    getProducts(): Promise<{
+        id: string;
+        name: string;
+        description: string;
+        type: string;
+        prices: {
+            id: string;
+            unit_amount: number;
+            recurring: string;
+            currency: string;
+            workspace_amount: number;
+        }[];
+        payment_quantity: number;
+        is_active: boolean;
+    }[]>;
+    getPlanFlags(): Promise<{
+        values: {
+            EPICS_DISPLAY: boolean;
+            EPICS_SETTINGS: boolean;
+            PROJECT_UPDATES: boolean;
+            PROJECT_OVERVIEW: boolean;
+            INBOX_STACKING: boolean;
+            TIMELINE_DEPENDENCY: boolean;
+            NO_LOAD: boolean;
+            FILE_SIZE_LIMIT_PRO: boolean;
+            EDITOR_AI_OPS: boolean;
+            COLLABORATION_CURSOR: boolean;
+            PROJECT_GROUPING: boolean;
+            BULK_OPS_ADVANCED: boolean;
+            WORKSPACE_ACTIVE_CYCLES: boolean;
+            PAGE_ISSUE_EMBEDS: boolean;
+            PAGE_PUBLISH: boolean;
+            VIEW_ACCESS_PRIVATE: boolean;
+            VIEW_PUBLISH: boolean;
+            VIEW_LOCK: boolean;
+            ISSUE_TYPE_SETTINGS: boolean;
+            ISSUE_TYPE_DISPLAY: boolean;
+            WORKSPACE_PAGES: boolean;
+            BULK_OPS: boolean;
+            ESTIMATE_WITH_TIME: boolean;
+            ISSUE_WORKLOG: boolean;
+            OIDC_SAML_AUTH: boolean;
+        };
+    }>;
+    /**
+     * Creates a quick link, an issue link that is not associated with any issue.
+     * @param data - The input data for creating the quick link.
+     * @returns The created quick link.
+     * @throws {BadRequestException} If the API returns an array of links instead of a single link.
+     */
+    createQuickLink(data: ICreateIssueLink): Promise<import("@ever-gauzy/plugin-integration-plane-models").IIssueLink>;
+    /**
+     * Updates a quick link in the workspace.
+     * @param linkId - The ID of the quick link to update.
+     * @param data - The updated data for the quick link.
+     * @returns The updated quick link.
+     */
+    updateQuickLink(linkId: ID, data: ICreateIssueLink): Promise<import("@ever-gauzy/plugin-integration-plane-models").IIssueLink>;
+    /**
+     * Finds all quick links in the workspace.
+     * @returns A promise resolved to an array of quick links.
+     */
+    getQuickinks(): Promise<import("@ever-gauzy/plugin-integration-plane-models").IIssueLink[]>;
+    deleteQuickLink(linkId: ID): Promise<any>;
+    createWorkspapce(): Promise<void>;
+}