@acorex-platform/module-help-desk-client 0.0.21

package/types/acorex-platform-module-help-desk-client-contracts.d.ts

@@ -0,0 +1,149 @@
+import { AXPEntity, AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+
+interface AXMLogMessage {
+    type: 'log' | 'error' | 'warning';
+    message: string;
+    timeStamp: string;
+}
+interface AXMLogCaptureState {
+    logs: AXMLogMessage[];
+    canCapture: boolean;
+}
+
+declare const AXPHelpDeskMenuKeys: {
+    readonly ReportedIssues: "help-desk:menu:reported-issues";
+    readonly IssueTypes: "help-desk:menu:issue-types";
+    readonly MyReportedIssues: "help-desk:my-reported-issues";
+    readonly Divider1: "help-desk:divider-1";
+};
+
+/**
+ * Collaboration capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPCollaborationPermissionKeys: {
+    readonly Access: "Collaboration:Permission:Access";
+    readonly MaintainConversations: "Collaboration:Permission:MaintainConversations";
+    readonly MaintainMeetings: "Collaboration:Permission:MaintainMeetings";
+    readonly MaintainCalendars: "Collaboration:Permission:MaintainCalendars";
+    readonly MaintainCommunications: "Collaboration:Permission:MaintainCommunications";
+    readonly MaintainReservations: "Collaboration:Permission:MaintainReservations";
+    readonly MaintainHelpDesk: "Collaboration:Permission:MaintainHelpDesk";
+    readonly Setup: "Collaboration:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPCollaborationPermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXMPermissionsKeys: {
+    readonly Issue: {
+        readonly Management: "Collaboration:Permission:MaintainHelpDesk";
+        readonly MyReportedIssues: {
+            readonly Management: "Collaboration:Permission:MaintainHelpDesk";
+            readonly View: "Collaboration:Permission:MaintainHelpDesk";
+            readonly Edit: "Collaboration:Permission:MaintainHelpDesk";
+            readonly Delete: "Collaboration:Permission:MaintainHelpDesk";
+            readonly Create: "Collaboration:Permission:MaintainHelpDesk";
+        };
+        readonly ReportedIssues: {
+            readonly Management: "Collaboration:Permission:MaintainHelpDesk";
+            readonly View: "Collaboration:Permission:MaintainHelpDesk";
+            readonly Edit: "Collaboration:Permission:MaintainHelpDesk";
+            readonly Delete: "Collaboration:Permission:MaintainHelpDesk";
+            readonly Create: "Collaboration:Permission:MaintainHelpDesk";
+        };
+    };
+};
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+    };
+    readonly module: {
+        readonly route: "help-desk";
+        readonly name: "HelpDesk";
+        readonly title: "@help-desk:module.title";
+        readonly icon: "fa-light fa-file-invoice";
+    };
+    readonly entities: {
+        readonly issueType: {
+            readonly name: "IssueType";
+            readonly title: "@help-desk:issue-types.entities.issue-type.title";
+            readonly titlePlural: "@help-desk:issue-types.entities.issue-type.plural";
+            readonly icon: "fa-light fa-list";
+        };
+        readonly reportedIssues: {
+            readonly name: "ReportedIssues";
+            readonly title: "@help-desk:reported-issues.entities.reported-issue.title";
+            readonly titlePlural: "@help-desk:reported-issues.entities.reported-issue.plural";
+            readonly icon: "fa-light fa-bug";
+        };
+        readonly myReportedIssues: {
+            readonly name: "MyReportedIssues";
+            readonly title: "@help-desk:my-reported-issues.entities.my-reported-issue.title";
+            readonly titlePlural: "@help-desk:my-reported-issues.entities.my-reported-issue.plural";
+            readonly icon: "fa-light fa-message-exclamation";
+        };
+        readonly reportNewIssue: {
+            readonly name: "ReportNewIssue";
+            readonly title: "@help-desk:report-new-issue.entities.report-new-issue.title";
+            readonly titlePlural: "@help-desk:report-new-issue.entities.report-new-issue.plural";
+            readonly icon: "fa-light fa-clipboard-list-check";
+        };
+    };
+};
+
+declare function issueTypeEntityFactory(): Promise<AXPEntity | null>;
+
+interface AXMHelpDeskIssueTypeEntityModel extends AXPEntityModel<string> {
+    name: string;
+    title: string;
+    description?: string;
+}
+
+declare function myReportedIssuesEntityFactory(): Promise<AXPEntity | null>;
+
+interface AXMHelpDeskMyReportedIssuesEntityModel extends AXPEntityModel<string> {
+    id: string;
+    user: any;
+    issueType: {
+        title: string;
+        id: string;
+    };
+    priority: {
+        title: string;
+        id: string;
+    };
+    status: string;
+    title: string;
+    description: string;
+    attachments?: any[];
+    systemInfo: string;
+    errorLogs: AXMLogMessage[];
+    createdAt: Date;
+}
+
+declare function reportedIssuesEntityFactory(): Promise<AXPEntity | null>;
+
+interface AXMHelpDeskReportedIssuesEntityModel extends AXPEntityModel<string> {
+    id: string;
+    user: any;
+    issueType: {
+        title: string;
+        id: string;
+    };
+    priority: {
+        title: string;
+        id: string;
+    };
+    status: string;
+    title: string;
+    description: string;
+    attachments?: any[];
+    systemInfo: string;
+    errorLogs: AXMLogMessage[];
+    createdAt: Date;
+}
+
+export { AXMPermissionsKeys, AXPCollaborationPermissionKeys, AXPHelpDeskMenuKeys, RootConfig, issueTypeEntityFactory, myReportedIssuesEntityFactory, reportedIssuesEntityFactory };
+export type { AXMHelpDeskIssueTypeEntityModel, AXMHelpDeskMyReportedIssuesEntityModel, AXMHelpDeskReportedIssuesEntityModel, AXMLogCaptureState, AXMLogMessage };

package/types/acorex-platform-module-help-desk-client.d.ts

@@ -0,0 +1,58 @@
+import * as _ngrx_signals from '@ngrx/signals';
+import * as _angular_core from '@angular/core';
+import * as _acorex_platform_module_help_desk_client_contracts from '@acorex-platform/module-help-desk-client/contracts';
+import { AXPStatusProvider, AXPStatusDefinition, AXPStatusTransition } from '@acorex-platform/framework-shared/core';
+import * as i1 from '@acorex-platform/framework-client/core';
+import { AXPMenuProvider, AXPMenuProviderContext, AXPSettingDefinitionProvider, AXPSettingDefinitionProviderContext } from '@acorex-platform/framework-client/common';
+import { AXPPermissionDefinitionProvider, AXPPermissionDefinitionProviderContext } from '@acorex-platform/framework-client/auth';
+
+declare const AXMLogCaptureService: _angular_core.Type<{
+    logs: _angular_core.Signal<_acorex_platform_module_help_desk_client_contracts.AXMLogMessage[]>;
+    canCapture: _angular_core.Signal<boolean>;
+    canCaptureLog: _angular_core.Signal<boolean>;
+    consoleLogs: _angular_core.Signal<_acorex_platform_module_help_desk_client_contracts.AXMLogMessage[]>;
+    startCapturingLog: () => void;
+    finishCapturingLog: () => void;
+    addConsoleLog: (message: string) => void;
+    addConsoleError: (message: string) => void;
+    addConsoleWarning: (message: string) => void;
+} & _ngrx_signals.StateSource<{
+    logs: _acorex_platform_module_help_desk_client_contracts.AXMLogMessage[];
+    canCapture: boolean;
+}>>;
+
+/**
+ * Provides lifecycle status definitions for reported issues.
+ */
+declare class AXMReportedIssuesStatusProvider extends AXPStatusProvider {
+    readonly key = "help-desk.status.reported-issues";
+    readonly statuses: AXPStatusDefinition[];
+    readonly transitions: AXPStatusTransition[];
+    readonly defaultStatus = "new";
+}
+
+declare class AXMHelpDeskModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMHelpDeskModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXMHelpDeskModule, never, [typeof i1.AXPComponentSlotModule], never>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXMHelpDeskModule>;
+}
+
+declare class AXMMenuProvider implements AXPMenuProvider {
+    private entityService;
+    provide(context: AXPMenuProviderContext): Promise<void>;
+}
+
+/**
+ * Registers help desk capabilities into the shared Collaboration group.
+ */
+declare class AXMPermissionDefinitionProvider implements AXPPermissionDefinitionProvider {
+    define(context: AXPPermissionDefinitionProviderContext): Promise<void>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMPermissionDefinitionProvider, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<AXMPermissionDefinitionProvider>;
+}
+
+declare class AXMSettingProvider implements AXPSettingDefinitionProvider {
+    provide(context: AXPSettingDefinitionProviderContext): Promise<void>;
+}
+
+export { AXMHelpDeskModule, AXMLogCaptureService, AXMMenuProvider, AXMPermissionDefinitionProvider, AXMReportedIssuesStatusProvider, AXMSettingProvider };