@acorex/modules 20.2.0-next.4 → 20.2.0

package/party-management/README.md

@@ -0,0 +1,177 @@
+# Party Management Module
+
+This module provides centralized party management functionality for the ACoreX Platform, supporting both individual and organizational parties with role assignments, relationships, and official identifiers.
+
+## Overview
+
+The Party Management module enables organizations to maintain detailed records of people and organizations (called **parties**) that can take on various business roles, have official identifiers, and maintain relationships with other parties. It is the root identity system for all business entities in the platform.
+
+## Core Features
+
+- **Unified Party Records**: Supports individuals and organizations in a single structure.
+- **Role Management**: Assign multiple business roles (customer, vendor, subcontractor, etc.) to a party.
+- **Party Relationships**: Define and manage complex relationships between parties (employs, client-of, subsidiary-of, etc.).
+- **Official Identifiers**: Maintain validated identification data with configurable types.
+- **Identifier Type Management**: Fully configurable types for party identifiers, with validation rules and scoping.
+
+## Entity Architecture
+
+The module consists of 5 interconnected entities:
+
+```
+Party (Main Entity)
+├── PartyRole (Related)
+├── PartyRelationship (Related)
+├── PartyIdentifier (Related)
+│    └── PartyIdentifierType (Lookup/Config)
+```
+
+## Entity Definitions
+
+### 1. AXPParty (Main Entity)
+
+Represents a root identity, either an individual or an organization, within the system.
+
+**Key Properties:**
+
+- `type`: `'individual' | 'organization'`
+- `displayName`: Primary display name
+- `firstName`, `lastName`: For individuals
+- `legalName`: For organizations
+- `status`: `'active' | 'inactive' | 'blocked' | 'archived'`
+- `roles`: Quick access list of assigned roles
+- `tags`, `segments`: Optional categorization
+- `primaryLocationId`: Optional denormalized pointer to a main location
+- `meta`: Custom metadata
+
+**Sample Data:**
+
+```json
+{
+  "id": "p1",
+  "type": "organization",
+  "displayName": "Tech Solutions Inc.",
+  "legalName": "Tech Solutions Incorporated",
+  "status": "active",
+  "roles": ["vendor", "customer"],
+  "tags": ["IT", "Enterprise"],
+  "segments": ["B2B"],
+  "primaryLocationId": "loc1"
+}
+```
+
+---
+
+### 2. AXPPartyRole (Related Entity)
+
+Assigns one or more business roles to a party, with optional validity periods.
+
+**Key Properties:**
+
+- `partyId`: Reference to `AXPParty`
+- `role`: `'customer' | 'vendor' | 'subcontractor' | 'client' | 'employee' | ...`
+- `status`: `'active' | 'inactive'`
+- `since`, `until`: Role validity period
+- `meta`: Custom metadata
+
+**Sample Data:**
+
+```json
+{
+  "id": "pr1",
+  "partyId": "p1",
+  "role": "vendor",
+  "status": "active",
+  "since": "2024-01-01"
+}
+```
+
+---
+
+### 3. AXPPartyRelationship (Related Entity)
+
+Defines relationships between two parties.
+
+**Key Properties:**
+
+- `fromPartyId`: Source party
+- `toPartyId`: Target party
+- `type`: `'employs' | 'works-for' | 'subsidiary-of' | 'parent-of' | 'client-of' | 'vendor-of' | 'member-of' | ...`
+- `validFrom`, `validTo`: Relationship validity
+- `notes`: Optional description
+- `meta`: Custom metadata
+
+**Sample Data:**
+
+```json
+{
+  "id": "rel1",
+  "fromPartyId": "p1",
+  "toPartyId": "p2",
+  "type": "client-of",
+  "validFrom": "2023-05-01",
+  "notes": "Long-term enterprise client"
+}
+```
+
+---
+
+### 4. AXPPartyIdentifierType (Lookup Entity)
+
+Represents a configurable type of official identifier that can be assigned to parties.
+
+**Key Properties:**
+
+- `code`: Machine-friendly code (e.g., `vat`, `company-id`, `passport`)
+- `title`: Human-readable title
+- `description`: Optional description
+- `scope`: `'party' | 'contact' | 'both'`
+- `formatRegex`: Optional regex for value validation
+- `minLength`, `maxLength`: Optional length constraints
+- `allowedCountries`: Optional ISO country codes
+- `isUnique`: Whether this identifier type must be unique
+- `isActive`: Active flag
+
+**Sample Data:**
+
+```json
+{
+  "id": "idtype1",
+  "code": "vat",
+  "title": "VAT Number",
+  "scope": "party",
+  "formatRegex": "^[A-Z]{2}[0-9A-Z]{8,12}$",
+  "isUnique": true,
+  "isActive": true
+}
+```
+
+---
+
+### 5. AXPPartyIdentifier (Related Entity)
+
+Stores a specific identifier assigned to a party.
+
+**Key Properties:**
+
+- `partyId`: Reference to `AXPParty`
+- `typeId`: Reference to `AXPPartyIdentifierType`
+- `value`: Identifier value
+- `country`: Optional ISO country code
+- `issuer`: Optional issuing authority
+- `validFrom`, `validTo`: Optional validity dates
+- `isPrimary`: Whether this is the primary identifier of this type
+- `meta`: Custom metadata
+
+**Sample Data:**
+
+```json
+{
+  "id": "pid1",
+  "partyId": "p1",
+  "typeId": "idtype1",
+  "value": "DE123456789",
+  "country": "DE",
+  "isPrimary": true
+}
+```

package/party-management/index.d.ts

@@ -0,0 +1,86 @@
+import * as i0 from '@angular/core';
+import { Injector } from '@angular/core';
+import * as i1 from '@angular/common';
+import { AXPEntity, AXPMenuProvider, AXPMenuProviderContext, AXPSearchCommandProvider, AXPSearchResult, AXPSettingDefinitionProvider, AXPSettingDefinitionProviderContext } from '@acorex/platform/common';
+import { AXPEntityDefinitionLoader, AXPEntityDefinitionPreloader, AXPEntityPreloadEntity } from '@acorex/platform/layout/entity';
+
+declare class AXMPartyManagementModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMPartyManagementModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMPartyManagementModule, never, [typeof i1.CommonModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMPartyManagementModule>;
+}
+
+declare const RootConfig: {
+    config: {
+        i18n: string;
+    };
+    module: {
+        name: string;
+        title: string;
+        icon: string;
+    };
+    entities: {
+        party: {
+            name: string;
+            title: string;
+            titlePlural: string;
+            icon: string;
+        };
+        partyRole: {
+            name: string;
+            title: string;
+            titlePlural: string;
+            icon: string;
+        };
+        partyRelationship: {
+            name: string;
+            title: string;
+            titlePlural: string;
+            icon: string;
+        };
+        partyRelationshipType: {
+            name: string;
+            title: string;
+            titlePlural: string;
+            icon: string;
+        };
+        partyIdentifierType: {
+            name: string;
+            title: string;
+            titlePlural: string;
+            icon: string;
+        };
+        partyIdentifier: {
+            name: string;
+            title: string;
+            titlePlural: string;
+            icon: string;
+        };
+    };
+};
+
+declare class AXMPartyManagementEntityProvider implements AXPEntityDefinitionLoader, AXPEntityDefinitionPreloader {
+    private injector;
+    preload(): AXPEntityPreloadEntity[];
+    get(moduleName: string, entityName: string): Promise<AXPEntity | null>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMPartyManagementEntityProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMPartyManagementEntityProvider>;
+}
+
+declare class AXMMenuProvider implements AXPMenuProvider {
+    private entityService;
+    provide(context: AXPMenuProviderContext): Promise<void>;
+}
+
+declare class AXMSearchCommandProvider extends AXPSearchCommandProvider {
+    commands: AXPSearchResult[];
+}
+
+declare class AXMSettingProvider implements AXPSettingDefinitionProvider {
+    private injector;
+    private readonly translateService;
+    constructor(injector: Injector);
+    provide(context: AXPSettingDefinitionProviderContext): Promise<void>;
+}
+
+export { AXMMenuProvider, AXMPartyManagementEntityProvider, AXMPartyManagementModule, AXMSearchCommandProvider, AXMSettingProvider, RootConfig };

package/platform-management/index.d.ts

@@ -6,9 +6,7 @@ import * as i3 from '@acorex/platform/layout/components';
 import { AXPEntity } from '@acorex/platform/common';
 import { AXPEntityModel, AXMEntityCrudServiceImpl } from '@acorex/platform/layout/entity';
 import { SafeHtml, DomSanitizer } from '@angular/platform-browser';
-import { AXPPageLayoutBaseComponent } from '@acorex/platform/layout/views';
 import { AXBasePageComponent } from '@acorex/components/page';
-import { AXPMetaDataDefinition } from '@acorex/platform/layout/builder';
 
 declare class AppTermsCheckService {
     private settingsService;
@@ -66,12 +64,6 @@ declare const RootConfig: {
         icon: string;
     };
     entities: {
-        glossary: {
-            name: string;
-            title: string;
-            titlePlural: string;
-            icon: string;
-        };
         localizationManagement: {
             name: string;
             title: string;
@@ -88,86 +80,9 @@ declare const RootConfig: {
             titlePlural: string;
             icon: string;
         };
-        appTerm: {
-            name: string;
-            title: string;
-            titlePlural: string;
-            pageTitle: string;
-            pageDescription: string;
-            icon: string;
-        };
-        metaDataDefinitionCategory: {
-            name: string;
-            title: string;
-            titlePlural: string;
-            icon: string;
-        };
-        metaDataDefinition: {
-            name: string;
-            title: string;
-            titlePlural: string;
-            icon: string;
-        };
     };
 };
 
-declare function appTermEntityEntityFactory(injector: Injector): Promise<AXPEntity | null>;
-
-interface AXMAppTermEntityModel extends AXPEntityModel<string> {
-    type: string;
-    title: string;
-    content: string;
-    version: number;
-    effectiveDate: string;
-    notifyUser: boolean;
-}
-interface AXMAppTermViewModel {
-    id?: string;
-    type: string;
-    title: string;
-    content: SafeHtml;
-    version: number;
-    effectiveDate: string;
-    notifyUser: boolean;
-}
-
-declare abstract class AXMAppTermService extends AXMEntityCrudServiceImpl<string, AXMAppTermEntityModel> {
-}
-declare class AXMAppTermServiceImpl extends AXMEntityCrudServiceImpl<string, AXMAppTermEntityModel> {
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<AXMAppTermServiceImpl, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AXMAppTermServiceImpl>;
-}
-
-declare class AXMListTermsComponent extends AXPPageLayoutBaseComponent {
-    private service;
-    protected terms: AXMAppTermViewModel[];
-    protected loaded: i0.WritableSignal<boolean>;
-    protected showScrollSide: i0.WritableSignal<boolean>;
-    ngAfterViewInit(): void;
-    onResize(): void;
-    checkScroll(): void;
-    ngOnInit(): Promise<void>;
-    protected getPageTitle(): string | Promise<string>;
-    protected getPageDescription(): string | Promise<string>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AXMListTermsComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<AXMListTermsComponent, "ng-component", never, {}, {}, never, never, true, never>;
-}
-
-declare class AXMNotifyNewTermPopupAction extends AXPWorkflowAction {
-    private popupService;
-    execute(context: AXPWorkflowContext): Promise<void>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AXMNotifyNewTermPopupAction, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AXMNotifyNewTermPopupAction>;
-}
-declare class AXMTermUpdateSettingAction extends AXPWorkflowAction {
-    private settingService;
-    execute(context: AXPWorkflowContext): Promise<void>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AXMTermUpdateSettingAction, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AXMTermUpdateSettingAction>;
-}
-declare const AXMNewTermWorkflow: AXPWorkflow;
-
 declare function appVersionEntityEntityFactory(injector: Injector): Promise<AXPEntity | null>;
 
 interface AXMAppVersionEntityModel extends AXPEntityModel<string> {
@@ -251,58 +166,5 @@ declare class AXMGlobalVariablesServiceImpl extends AXMEntityCrudServiceImpl<str
     static ɵprov: i0.ɵɵInjectableDeclaration<AXMGlobalVariablesServiceImpl>;
 }
 
-declare function glossaryEntityFactory(injector: Injector): Promise<AXPEntity | null>;
-
-interface AXMPlatformManagementGlossaryEntityModel extends AXPEntityModel<string> {
-    name: string;
-}
-
-declare abstract class AXMGlossaryService extends AXMEntityCrudServiceImpl<string, AXMPlatformManagementGlossaryEntityModel> {
-}
-declare class AXMGlossaryServiceImpl extends AXMGlossaryService {
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<AXMGlossaryServiceImpl, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AXMGlossaryServiceImpl>;
-}
-
-declare function metaDataDefinitionFactory(injector: Injector): Promise<AXPEntity | null>;
-
-declare function metaDataDefinitionCategoryEntityFactory(injector: Injector): Promise<AXPEntity | null>;
-
-interface AXMMetaDataDefinitionCategoryEntityModel<T = string> extends AXPEntityModel<T> {
-    name: string;
-    title: string;
-    parentId?: T | undefined;
-    childCount?: number;
-    children?: AXMMetaDataDefinitionCategoryEntityModel[];
-}
-interface AXMMetaDataDefinitionCategoryWithItemsEntityModel<T = string> extends AXMMetaDataDefinitionCategoryEntityModel<T> {
-    items: AXMMetaDataDefinitionEntityModel<T>[];
-    categories: AXMMetaDataDefinitionCategoryWithItemsEntityModel<T>[];
-}
-
-declare abstract class AXMMetaDataDefinitionCategoryService<T = string> extends AXMEntityCrudServiceImpl<T, AXMMetaDataDefinitionCategoryEntityModel<T>> {
-    abstract getAllWithItems(): Promise<AXMMetaDataDefinitionCategoryWithItemsEntityModel<T>[]>;
-}
-declare class AXMMetaDataDefinitionCategoryServiceImpl extends AXMMetaDataDefinitionCategoryService {
-    constructor();
-    getAllWithItems(): Promise<AXMMetaDataDefinitionCategoryWithItemsEntityModel<string>[]>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AXMMetaDataDefinitionCategoryServiceImpl, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AXMMetaDataDefinitionCategoryServiceImpl>;
-}
-
-interface AXMMetaDataDefinitionEntityModel<T = string> extends AXPEntityModel<T>, AXPMetaDataDefinition {
-    categoryIds: T[];
-    categories?: AXMMetaDataDefinitionCategoryEntityModel[];
-}
-
-declare abstract class AXMMetaDataDefinitionService<T = string> extends AXMEntityCrudServiceImpl<T, AXMMetaDataDefinitionEntityModel<T>> {
-}
-declare class AXMPMetaDataDefinitionServiceImpl extends AXMMetaDataDefinitionService<string> {
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<AXMPMetaDataDefinitionServiceImpl, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AXMPMetaDataDefinitionServiceImpl>;
-}
-
-export { AXMAppTermService, AXMAppTermServiceImpl, AXMAppVersionService, AXMAppVersionServiceImpl, AXMAppVersionSlotComponent, AXMChangeLogPopupAction, AXMChangeLogUpdateSettingAction, AXMCheckNewVersionAction, AXMCheckNewVersionWorkflow, AXMGlobalVariablesService, AXMGlobalVariablesServiceImpl, AXMGlossaryService, AXMGlossaryServiceImpl, AXMListTermsComponent, AXMMetaDataDefinitionCategoryService, AXMMetaDataDefinitionCategoryServiceImpl, AXMMetaDataDefinitionService, AXMNewTermWorkflow, AXMNotifyAppComponent, AXMNotifyNewTermPopupAction, AXMPMetaDataDefinitionServiceImpl, AXMPlatformManagementModule, AXMTermUpdateSettingAction, AXMWhatsNewWorkflow, RootConfig, appTermEntityEntityFactory, appVersionEntityEntityFactory, globalVariableEntityFactory, glossaryEntityFactory, metaDataDefinitionCategoryEntityFactory, metaDataDefinitionFactory };
-export type { AXMAppTermEntityModel, AXMAppTermViewModel, AXMAppVersionEntityModel, AXMAppVersionListComponentModel, AXMGlobalVariableEntityModel, AXMMetaDataDefinitionCategoryEntityModel, AXMMetaDataDefinitionCategoryWithItemsEntityModel, AXMMetaDataDefinitionEntityModel, AXMPlatformManagementGlossaryEntityModel };
+export { AXMAppVersionService, AXMAppVersionServiceImpl, AXMAppVersionSlotComponent, AXMChangeLogPopupAction, AXMChangeLogUpdateSettingAction, AXMCheckNewVersionAction, AXMCheckNewVersionWorkflow, AXMGlobalVariablesService, AXMGlobalVariablesServiceImpl, AXMNotifyAppComponent, AXMPlatformManagementModule, AXMWhatsNewWorkflow, RootConfig, appVersionEntityEntityFactory, globalVariableEntityFactory };
+export type { AXMAppVersionEntityModel, AXMAppVersionListComponentModel, AXMGlobalVariableEntityModel };