@acorex-platform/module-location-management-client 0.0.15 → 0.0.18

package/types/acorex-platform-module-location-management-client-contracts.d.ts

@@ -0,0 +1,274 @@
+import { AXPEntityAction, AXPEntityProperty, AXPQueryFilter, AXPEntity, AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+import { AXPMultiLanguageString, AXPEntityReference } from '@acorex-platform/framework-shared/core';
+
+/** Location Management datasource registry names. */
+declare const AXMLocationManagementDataSourceKeys: {
+    readonly Countries: "countries";
+    readonly Provinces: "provinces";
+    readonly Cities: "cities";
+};
+
+declare const AXMLocationManagementFeatureKeys: {};
+
+/** Read-only assignments list on Location detail (no create/update/delete). */
+declare function locationAssignmentReadOnlyRelatedActions(): AXPEntityAction[];
+/**
+ * Actions for LocationAssignment when shown from Party/Customer/Supplier.
+ * Create menu: assign existing location or create new location with assignee prefilled.
+ */
+declare function locationAssignmentDetailsCrudActionsForPartyContext(_partyIdContextPath?: string): AXPEntityAction[];
+
+type LocationAssignmentLocationSnapshot = {
+    id: string;
+    title: string;
+    fullAddress?: string;
+    street1?: string;
+    street2?: string;
+    postalCode?: string;
+    city?: {
+        title: string;
+    };
+    state?: {
+        title: string;
+    };
+    country?: {
+        title: string;
+    };
+};
+type LocationAssignmentPersonSnapshot = {
+    id: string;
+    fullName?: string;
+    phones?: unknown[];
+    emails?: unknown[];
+};
+/** Canonical assignee type for party-scoped location assignment links. */
+declare const LOCATION_ASSIGNMENT_PARTY_TYPE = "BusinessCore.Party";
+/** Resolves assignee display title from host/process data (plain string or multi-language object). */
+declare function resolveLocationAssignmentDisplayTitle(locale: string, ...candidates: unknown[]): string;
+/** Builds a location snapshot for nested LocationAssignment display fields. */
+declare function buildLocationAssignmentLocationSnapshot(locationRow: Record<string, unknown>, locationId: string): LocationAssignmentLocationSnapshot;
+/** Builds a person snapshot for nested LocationAssignment site-contact fields. */
+declare function buildLocationAssignmentPersonSnapshot(personRow: Record<string, unknown>, personId: string): LocationAssignmentPersonSnapshot;
+/** Filters LocationAssignment rows for a location detail context. */
+declare function locationAssignmentLocationConditions(locationIdContextPath?: string): AXPQueryFilter[];
+/** Filters LocationAssignment rows for the current details-view host entity. */
+declare function locationAssignmentPartyConditions(hostIdContextPath?: string): AXPQueryFilter[];
+/** Assignee lookup omitted when injected from party/customer/supplier context. */
+declare const LOCATION_ASSIGNMENT_REF_PROPERTY_NAMES: readonly ["ownerRef.id", "ownerRef.type"];
+/** Location lookup omitted when injected from location detail context. */
+declare const LOCATION_ASSIGNMENT_LOCATION_PROPERTY_NAMES: readonly ["locationId"];
+type PropertyLayoutRef = {
+    name: string;
+    layout?: Record<string, unknown>;
+};
+declare function omitLocationAssignmentRefFromEditLayouts<T extends PropertyLayoutRef>(layouts: T[]): T[];
+declare function omitLocationAssignmentLocationFromEditLayouts<T extends PropertyLayoutRef>(layouts: T[]): T[];
+/** Polymorphic assignee lookup (AssessmentCase subjectRef pattern). */
+declare function createLocationAssignmentOwnerRefLookupProperty(groupId: string, options?: {
+    readonly?: boolean;
+}): AXPEntityProperty;
+/** Hidden assignee type field; defaults to BusinessCore.Party. */
+declare function createLocationAssignmentOwnerRefTypeProperty(groupId: string): AXPEntityProperty;
+
+declare const AXPLocationManagementMenuKeys: {
+    readonly Root: "location-management:menu";
+    readonly Locations: "location-management:menu:locations";
+    readonly Divider1: "location-management:menu:divider-1";
+    readonly LocationTypes: "location-management:menu:location-types";
+    readonly LocationRoles: "location-management:menu:location-roles";
+    readonly GeographicRegions: "location-management:menu:geographic-regions";
+};
+
+declare const AXMLocationManagementPermissionsKeys: {
+    LocationManagement: {
+        Management: string;
+        Locations: {
+            Management: string;
+            View: string;
+            Edit: string;
+            Delete: string;
+            Create: string;
+        };
+        LocationTypes: {
+            Management: string;
+            View: string;
+            Edit: string;
+            Delete: string;
+            Create: string;
+        };
+        LocationRoles: {
+            Management: string;
+            View: string;
+            Edit: string;
+            Delete: string;
+            Create: string;
+        };
+        GeographicRegions: {
+            Management: string;
+            View: string;
+            Edit: string;
+            Delete: string;
+            Create: string;
+        };
+    };
+};
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+    };
+    readonly module: {
+        readonly name: "LocationManagement";
+        readonly title: "@location-management:module.title";
+        readonly icon: "fa-light fa-map-marker-alt";
+    };
+    readonly entities: {
+        readonly location: {
+            readonly name: "Location";
+            readonly title: "@location-management:locations.entities.location.title";
+            readonly titlePlural: "@location-management:locations.entities.location.plural";
+            readonly icon: "fa-light fa-map-marker-alt";
+        };
+        readonly locationType: {
+            readonly name: "LocationType";
+            readonly title: "@location-management:location-types.entities.location-type.title";
+            readonly titlePlural: "@location-management:location-types.entities.location-type.plural";
+            readonly icon: "fa-light fa-tags";
+        };
+        readonly locationRole: {
+            readonly name: "LocationRole";
+            readonly title: "@location-management:location-roles.entities.location-role.title";
+            readonly titlePlural: "@location-management:location-roles.entities.location-role.plural";
+            readonly icon: "fa-light fa-map-pin";
+        };
+        readonly geographicRegion: {
+            readonly name: "GeographicRegion";
+            readonly title: "@location-management:geographic-regions.entities.geographic-region.title";
+            readonly titlePlural: "@location-management:geographic-regions.entities.geographic-region.plural";
+            readonly icon: "fa-light fa-globe";
+        };
+        readonly locationAssignment: {
+            readonly name: "LocationAssignment";
+            readonly title: `@${string}:location-assignments.entities.location-assignment.title`;
+            readonly titlePlural: `@${string}:location-assignments.entities.location-assignment.plural`;
+            readonly icon: "fa-light fa-building-user";
+        };
+    };
+};
+
+declare function geographicRegionFactory(): Promise<AXPEntity | null>;
+
+interface AXMLocationManagementGeographicRegionEntityModel extends AXPEntityModel<string> {
+    title: string;
+    code?: string;
+    type: string;
+    parentId?: string;
+    coordinates?: string;
+    timezone?: string;
+    population?: number;
+    area?: number;
+    /** Foreign key to Financial Core Currency. */
+    currencyId?: string;
+    currency?: {
+        id: string;
+        code: string;
+        symbol: string;
+        title: AXPMultiLanguageString;
+    };
+    isActive: boolean;
+}
+interface GeographicRegionHierarchy {
+    country?: AXMLocationManagementGeographicRegionEntityModel;
+    state?: AXMLocationManagementGeographicRegionEntityModel;
+    city?: AXMLocationManagementGeographicRegionEntityModel;
+    district?: AXMLocationManagementGeographicRegionEntityModel;
+}
+
+declare function locationFactory(): Promise<AXPEntity | null>;
+
+interface AXMLocationManagementLocationEntityModel extends AXPEntityModel<string> {
+    title: string;
+    code?: string;
+    locationTypeId?: string;
+    locationType?: {
+        id: string;
+        title: string;
+        description?: string;
+        icon?: string;
+        color?: string;
+    };
+    street1: string;
+    street2?: string;
+    countryId?: string;
+    stateId?: string;
+    cityId?: string;
+    districtId?: string;
+    postalCode: string;
+    coordinates?: string;
+    description?: string;
+    parentLocationId?: string;
+    isPrimary?: boolean;
+    isActive: boolean;
+    validFrom?: Date;
+    validTo?: Date;
+    timezone?: string;
+    /** Computed: formatted address (from computed-property plugin) */
+    fullAddress?: string;
+}
+
+declare function locationAssignmentFactory(): Promise<AXPEntity>;
+
+interface AXMLocationManagementLocationAssignmentEntityModel extends AXPEntityModel<string> {
+    locationId: string;
+    ownerRef: AXPEntityReference;
+    roleId: string;
+    personId?: string;
+    location?: {
+        id: string;
+        title: string;
+        fullAddress?: string;
+        street1?: string;
+        street2?: string;
+        postalCode?: string;
+        city?: {
+            title: string;
+        };
+        state?: {
+            title: string;
+        };
+        country?: {
+            title: string;
+        };
+    };
+    role?: {
+        id: string;
+        title: string;
+    };
+    person?: {
+        id: string;
+        fullName?: string;
+        phones?: unknown[];
+        emails?: unknown[];
+    };
+}
+
+declare function locationRoleFactory(): Promise<AXPEntity>;
+
+interface AXMLocationManagementLocationRoleEntityModel extends AXPEntityModel<string> {
+    name: string;
+    title: string;
+    description?: string | null;
+}
+
+declare function locationTypeFactory(): Promise<AXPEntity | null>;
+
+interface AXMLocationManagementLocationTypeEntityModel extends AXPEntityModel<string> {
+    title: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    isActive: boolean;
+}
+
+export { AXMLocationManagementDataSourceKeys, AXMLocationManagementFeatureKeys, AXMLocationManagementPermissionsKeys, AXPLocationManagementMenuKeys, LOCATION_ASSIGNMENT_LOCATION_PROPERTY_NAMES, LOCATION_ASSIGNMENT_PARTY_TYPE, LOCATION_ASSIGNMENT_REF_PROPERTY_NAMES, RootConfig, buildLocationAssignmentLocationSnapshot, buildLocationAssignmentPersonSnapshot, createLocationAssignmentOwnerRefLookupProperty, createLocationAssignmentOwnerRefTypeProperty, geographicRegionFactory, locationAssignmentDetailsCrudActionsForPartyContext, locationAssignmentFactory, locationAssignmentLocationConditions, locationAssignmentPartyConditions, locationAssignmentReadOnlyRelatedActions, locationFactory, locationRoleFactory, locationTypeFactory, omitLocationAssignmentLocationFromEditLayouts, omitLocationAssignmentRefFromEditLayouts, resolveLocationAssignmentDisplayTitle };
+export type { AXMLocationManagementGeographicRegionEntityModel, AXMLocationManagementLocationAssignmentEntityModel, AXMLocationManagementLocationEntityModel, AXMLocationManagementLocationRoleEntityModel, AXMLocationManagementLocationTypeEntityModel, GeographicRegionHierarchy };

package/types/acorex-platform-module-location-management-client.d.ts

@@ -0,0 +1,53 @@
+import * as i0 from '@angular/core';
+import * as i1 from '@angular/common';
+import * as i2 from '@acorex-platform/framework-client/layout/widget-core';
+import { AXPEntity } from '@acorex-platform/framework-shared/entity';
+import { AXPEntityDefinitionLoader, AXPEntityDefinitionPreloader, AXPEntityPreloadEntity } from '@acorex-platform/framework-client/layout/entity';
+import { AXPMenuProvider, AXPMenuProviderContext, AXPSearchCommandProvider, AXPSearchResult, AXPSettingDefinitionProvider, AXPSettingDefinitionProviderContext, AXPGeoLocation } from '@acorex-platform/framework-client/common';
+
+declare class AXMLocationManagementModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLocationManagementModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMLocationManagementModule, never, [typeof i1.CommonModule, typeof i2.AXPWidgetCoreModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMLocationManagementModule>;
+}
+
+declare class AXMLocationManagementEntityProvider implements AXPEntityDefinitionLoader, AXPEntityDefinitionPreloader {
+    preload(): AXPEntityPreloadEntity[];
+    get(moduleName: string, entityName: string): Promise<AXPEntity | null>;
+    list(): Promise<{
+        name: string;
+        module: string;
+    }[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLocationManagementEntityProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMLocationManagementEntityProvider>;
+}
+
+declare class AXMLocationManagementMenuProvider implements AXPMenuProvider {
+    private entityService;
+    provide(context: AXPMenuProviderContext): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLocationManagementMenuProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMLocationManagementMenuProvider>;
+}
+
+declare class AXMSearchCommandProvider extends AXPSearchCommandProvider {
+    commands: AXPSearchResult[];
+}
+
+declare class AXMSettingProvider implements AXPSettingDefinitionProvider {
+    provide(context: AXPSettingDefinitionProviderContext): Promise<void>;
+}
+
+declare class AXMLocationManagementService {
+    private readonly entityService;
+    private readonly geographicRegionDataAccessor;
+    getCountries(): Promise<AXPGeoLocation[]>;
+    getProvinces(countryId?: string): Promise<AXPGeoLocation[]>;
+    getCities(filter?: {
+        countryId?: string;
+        provinceId?: string;
+    }): Promise<AXPGeoLocation[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMLocationManagementService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMLocationManagementService>;
+}
+
+export { AXMLocationManagementEntityProvider, AXMLocationManagementMenuProvider, AXMLocationManagementModule, AXMLocationManagementService, AXMSearchCommandProvider, AXMSettingProvider };

package/contracts/datasource.keys.d.ts

@@ -1,6 +0,0 @@
-/** Location Management datasource registry names. */
-export declare const AXMLocationManagementDataSourceKeys: {
-    readonly Countries: "countries";
-    readonly Provinces: "provinces";
-    readonly Cities: "cities";
-};

package/contracts/datasource.keys.js

@@ -1,8 +0,0 @@
-//#region ---- Datasource keys ----
-/** Location Management datasource registry names. */
-export const AXMLocationManagementDataSourceKeys = {
-    Countries: 'countries',
-    Provinces: 'provinces',
-    Cities: 'cities',
-};
-//#endregion

package/contracts/entities/geographic-region/geographic-region.entity.d.ts

@@ -1,2 +0,0 @@
-import { AXPEntity } from '@acorex-platform/framework-shared/entity';
-export declare function geographicRegionFactory(): Promise<AXPEntity | null>;