@acorex-platform/module-content-management-client 0.0.21

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

@@ -0,0 +1,365 @@
+import { AXPFileStorageInfo, AXPPlatformScopeKey, AXPMultiLanguageString, AXPCategoryListItem } from '@acorex-platform/framework-shared/core';
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+
+declare const AXPContentManagementMenuKeys: {
+    readonly Root: "content-management:menu";
+    readonly HelpRoot: "app:help";
+    readonly Promotions: "content-management:menu:promotions";
+    readonly TextTemplates: "content-management:menu:text-templates";
+    readonly Glossary: "content-management:menu:glossary";
+    readonly HelpCenter: "app:help:center";
+    readonly Tutorials: "app:help:tutorials";
+    readonly About: "app:about";
+};
+
+/**
+ * Content & Documents capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPContentDocumentsPermissionKeys: {
+    readonly Access: "ContentDocuments:Permission:Access";
+    readonly MaintainDocuments: "ContentDocuments:Permission:MaintainDocuments";
+    readonly MaintainContent: "ContentDocuments:Permission:MaintainContent";
+    readonly MaintainFormTemplates: "ContentDocuments:Permission:MaintainFormTemplates";
+    readonly Setup: "ContentDocuments:Permission:Setup";
+};
+/**
+ * @deprecated Prefer {@link AXPContentDocumentsPermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXMPermissionsKeys: {
+    readonly ContentManagement: {
+        readonly Management: "ContentDocuments:Permission:MaintainContent";
+        readonly Promotion: {
+            readonly Management: "ContentDocuments:Permission:MaintainContent";
+            readonly View: "ContentDocuments:Permission:MaintainContent";
+            readonly Edit: "ContentDocuments:Permission:MaintainContent";
+            readonly Delete: "ContentDocuments:Permission:MaintainContent";
+            readonly Create: "ContentDocuments:Permission:MaintainContent";
+        };
+        readonly TextTemplate: {
+            readonly Management: "ContentDocuments:Permission:MaintainContent";
+            readonly View: "ContentDocuments:Permission:MaintainContent";
+            readonly Edit: "ContentDocuments:Permission:MaintainContent";
+            readonly Delete: "ContentDocuments:Permission:MaintainContent";
+            readonly Create: "ContentDocuments:Permission:MaintainContent";
+        };
+    };
+};
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+    };
+    readonly module: {
+        readonly module: "ContentManagement";
+        readonly name: "ContentManagement";
+        readonly title: `@${string}:module.title`;
+        readonly icon: "fa-light fa-file-invoice";
+    };
+    readonly entities: {
+        readonly promotion: {
+            readonly name: "Promotion";
+            readonly title: `@${string}:promotions.entities.promotion.title`;
+            readonly titlePlural: `@${string}:promotions.entities.promotion.plural`;
+            readonly icon: "fa-light fa-megaphone";
+        };
+        readonly glossary: {
+            readonly name: "Glossary";
+            readonly title: `@${string}:glossaries.entities.glossary.title`;
+            readonly titlePlural: `@${string}:glossaries.entities.glossary.plural`;
+            readonly icon: "fa-light fa-file";
+        };
+        readonly textTemplate: {
+            readonly name: "TextTemplate";
+            readonly title: `@${string}:templates.entities.text-template.title`;
+            readonly titlePlural: `@${string}:templates.entities.text-template.plural`;
+            readonly icon: "fa-light fa-envelope";
+        };
+    };
+};
+
+interface AXMPromotionEntityModel extends AXPEntityModel<string> {
+    name: string;
+    title: string;
+    body: string;
+    imageId?: string;
+    image?: AXPFileStorageInfo;
+    contentType?: AXMSelectModel;
+    shape?: AXMSelectModel;
+    placement?: AXMSelectModel;
+}
+interface AXMSelectModel {
+    name: string;
+    title: string;
+}
+
+type AXMTextTemplateTokenFormatMeta = {
+    dataType?: string;
+    format?: string;
+};
+/** Calendar system for date tokens (`solar-hijri` = Jalali / Persian). */
+type AXMTextTemplateCalendarSystem = 'gregory' | 'solar-hijri';
+type AXMTextTemplateRegionalFormatContext = {
+    locale: string;
+    shortDate: string;
+    shortTime: string;
+    timeZone: string;
+    /** When omitted, inferred from locale (`fa-*` → solar-hijri). */
+    calendar?: AXMTextTemplateCalendarSystem | string;
+};
+/**
+ * Default short-date pattern when settings do not provide ShortDate.
+ * Aligns with locale-management profiles (en-US / en-AU / en-NZ / fa-IR).
+ */
+declare function defaultShortDatePatternForLocale(locale: string): string;
+declare function defaultShortTimePatternForLocale(_locale: string): string;
+/**
+ * Resolves calendar: settings value, else `solar-hijri` for `fa-*`, else Gregorian.
+ */
+declare function resolveTextTemplateCalendar(locale: string, calendarSetting?: string | null): AXMTextTemplateCalendarSystem;
+/**
+ * Parses ISO / `YYYY-MM-DD` / Date-like merge values into a Date.
+ * Date-only keys are treated as UTC midnight to avoid off-by-one shifts.
+ */
+declare function parseTextTemplateDateValue(value: unknown): Date | null;
+/**
+ * Formats a date with regional patterns (`DD/MM/YYYY`, `D MMMM YYYY`, `HH:mm`, …)
+ * using the active locale for month names, digits, and calendar (Jalali for fa-IR).
+ */
+declare function formatTextTemplateDate(value: unknown, pattern: string, timeZone?: string, locale?: string, calendar?: AXMTextTemplateCalendarSystem | string): string;
+declare function formatTextTemplateNumber(value: unknown, locale: string, options?: {
+    style?: 'decimal' | 'integer' | 'currency' | 'percent';
+    currency?: string;
+}): string;
+/**
+ * Formats merge values using PlatformManagement.Token `dataType` / `format` metadata.
+ * Unknown tokens and non-typed strings are left unchanged.
+ */
+declare function formatTextTemplateMergeValues(merge: Record<string, string>, metaByName: Record<string, AXMTextTemplateTokenFormatMeta>, regional: AXMTextTemplateRegionalFormatContext): Record<string, string>;
+
+/** Stored value: { email: { subject?, body }, sms: { body }, ... } */
+interface AXMTextTemplateChannelsValue {
+    [channelName: string]: {
+        subject?: AXPMultiLanguageString;
+        body: AXPMultiLanguageString;
+    };
+}
+type AXMTextTemplateChannelEditorType = 'plain' | 'rich';
+interface AXMTextTemplateChannelConfigureSettings {
+    /** Settings definition section name (e.g. `smtp-settings`). */
+    section: string;
+    /** Optional parent group when section names are not unique. */
+    group?: string;
+    scope: AXPPlatformScopeKey;
+}
+interface AXMTextTemplateChannelDefinition {
+    name: string;
+    title: string;
+    type: AXMTextTemplateChannelEditorType;
+    hasSubject?: boolean;
+    communicationChannelKey?: string;
+    requiredSettingKeys?: string[];
+    configureSettings?: AXMTextTemplateChannelConfigureSettings;
+    notConfiguredMessageKey?: string;
+}
+interface AXMTextTemplateChannelDefinitionProvider {
+    getChannels(): AXMTextTemplateChannelDefinition[];
+}
+/** Template kind: content (leaf message) or master (layout shell with `[content]`). */
+declare const AXM_TEXT_TEMPLATE_KIND: {
+    readonly Content: "content";
+    readonly Master: "master";
+};
+type AXMTextTemplateKind = (typeof AXM_TEXT_TEMPLATE_KIND)[keyof typeof AXM_TEXT_TEMPLATE_KIND];
+/** Print / PDF channel key on `channels` (rich body, no subject). */
+declare const AXM_TEXT_TEMPLATE_PRINT_CHANNEL: "print";
+/** Reserved body slot for child template body injection (not a `{{token}}` variable). */
+declare const AXM_TEXT_TEMPLATE_CONTENT_SLOT: "[content]";
+/** Max `parentId` chain length (leaf → … → root), including the leaf. */
+declare const AXM_TEXT_TEMPLATE_MAX_PARENT_DEPTH = 5;
+interface AXMTextTemplateEntityModel extends AXPEntityModel<string> {
+    title?: AXPMultiLanguageString;
+    /** `content` (default) or `master` layout template. */
+    kind?: AXMTextTemplateKind;
+    /** Optional parent master template id (multi-level nesting supported). */
+    parentId?: string | null;
+    /** Join snapshot for `parentId` lookup. */
+    parent?: {
+        id?: string;
+        title?: AXPMultiLanguageString | string;
+    } | null;
+    channels?: AXMTextTemplateChannelsValue;
+    categoryIds?: string[];
+    categories?: AXPCategoryListItem[];
+}
+
+/**
+ * Collects unique placeholder token names from text (`{{name}}`).
+ */
+declare function collectTextTemplatePlaceholderNames(text: string): string[];
+/**
+ * Replaces `{{token}}` when `merge[token]` is defined; otherwise leaves the token unchanged.
+ */
+declare function replaceTextTemplatePlaceholders(text: string, merge: Record<string, string>): string;
+/**
+ * Resolves a template channel field (plain string or per-locale map) for the active locale.
+ */
+declare function resolveTextTemplateLocalizedString(value: AXPMultiLanguageString | string | undefined | null, locale: string): string;
+/**
+ * Returns true when `text` contains the reserved `[content]` slot.
+ */
+declare function textTemplateContainsContentSlot(text: string | null | undefined): boolean;
+/**
+ * Injects child body into every `[content]` occurrence in a master body.
+ */
+declare function replaceTextTemplateContentSlot(masterBody: string, content: string): string;
+/**
+ * Composes a body chain: leaf first, then parents toward root.
+ * Each level applies `{{token}}` merge; parents receive the child body via `[content]`.
+ */
+declare function composeTextTemplateBodyChain(bodiesLeafToRoot: string[], merge: Record<string, string>): string;
+/**
+ * Master templates: every non-empty channel body locale must include `[content]`.
+ * Content templates: no channel body may include `[content]`.
+ */
+declare function validateTextTemplateContentSlots(input: {
+    kind: AXMTextTemplateKind | string | undefined | null;
+    channels: AXMTextTemplateChannelsValue | undefined | null;
+}): {
+    ok: true;
+} | {
+    ok: false;
+    error: string;
+};
+interface AXMTextTemplateParentChainNode {
+    id: string;
+    kind?: string | null;
+    parentId?: string | null;
+}
+/**
+ * Validates parent reference and walks the parent chain for kind, cycles, and max depth.
+ * `loadParent` should return the next parent row (or null when missing).
+ */
+declare function validateTextTemplateParentChain(input: {
+    id?: string | null;
+    parentId?: string | null;
+    maxDepth?: number;
+    loadParent: (id: string) => Promise<AXMTextTemplateParentChainNode | null>;
+}): Promise<{
+    ok: true;
+} | {
+    ok: false;
+    error: string;
+}>;
+
+/** Server + client command key for rendering a text template channel. */
+declare const AXM_TEXT_TEMPLATE_RENDER_COMMAND_KEY: "ContentManagement:TextTemplate:Render";
+/**
+ * Request to render a persisted text template channel with merge values.
+ * Walks optional `parentId` masters and injects child body into `[content]`.
+ */
+interface AXMTextTemplateRenderRequest {
+    textTemplateId: string;
+    /**
+     * When set, `textTemplateId` may be a canonical seed id; the render engine
+     * remaps it with tenantMasterId(`content`, tenantId, id) for the tenant copy.
+     * Also used for settings cascade (tenant Language / ShortDate / …).
+     */
+    tenantId?: string;
+    /**
+     * Optional recipient / actor user id. When set, User Language and regional
+     * patterns are preferred over tenant/platform settings.
+     */
+    userId?: string;
+    /** Channel key on `channels`, e.g. `email`, `sms`. Defaults to `email`. */
+    channel?: string;
+    /**
+     * Explicit locale override for MLS subject/body and number formatting.
+     * When omitted, resolved from settings: User Language → Tenant Language →
+     * Platform Language → `en-US`.
+     */
+    locale?: string;
+    /**
+     * Event/domain values merged into `{{name}}` placeholders (e.g. `employeeName`, `documentTitle`).
+     * Prefer raw ISO dates and numeric strings — the render engine formats typed tokens
+     * (`DateTime`, `Integer`, `Decimal`, Currency/Percent) using regional settings.
+     * Context tokens used by shared masters (`companyName`, `companyEmail`, …) are filled by the
+     * render engine via PlatformManagement.Tokens when missing — do not re-supply them per caller.
+     */
+    merge?: Record<string, string>;
+}
+/**
+ * Rendered subject/body for one channel after placeholder replacement and parent composition.
+ */
+interface AXMTextTemplateRenderResult {
+    textTemplateId: string;
+    channel: string;
+    subject?: string;
+    body: string;
+}
+/** Server command key for previewing unsaved draft text template content. */
+declare const AXM_TEXT_TEMPLATE_PREVIEW_COMMAND_KEY: "ContentManagement:TextTemplate:Preview";
+/**
+ * Request to preview draft channel content with optional parent masters.
+ * Uses the same composition / Context token fill as render, then fills Event samples.
+ */
+interface AXMTextTemplatePreviewRequest {
+    /** Draft channel map from the editor (not persisted). */
+    channels: AXMTextTemplateChannelsValue;
+    /** Optional persisted master parent id to walk for `[content]` shells. */
+    parentId?: string | null;
+    /** Template kind from the host form (`content` | `master`). Informational. */
+    kind?: string;
+    /** Channel key on `channels`, e.g. `email`, `sms`. Defaults to `email`. */
+    channel?: string;
+    /**
+     * Locale for MLS fields and number formatting. Defaults to active UI language on the client,
+     * or `en-US` when omitted on the server.
+     */
+    locale?: string;
+    /** Optional merge overrides (applied before Context resolve and Event samples). */
+    merge?: Record<string, string>;
+}
+/**
+ * Preview subject/body for one channel after placeholder replacement and parent composition.
+ */
+interface AXMTextTemplatePreviewResult {
+    channel: string;
+    subject?: string;
+    body: string;
+}
+
+/**
+ * Namespace for {@link tenantMasterId} when cloning text templates per tenant
+ * (`packs` SetupTenant → `content-management.common-setup`).
+ */
+declare const AXM_TEXT_TEMPLATE_TENANT_MASTER_NAMESPACE: "content";
+/**
+ * Canonical ContentManagement.TextTemplate ids used as SetupTenant clone keys
+ * and runtime lookups (resolve via tenantMasterId + tenantId).
+ * Keep aligned with packs `text-template.mock.ids.ts`.
+ *
+ * Prefix `c71000` — same as `mockStableUuid('c71000', seq)`.
+ */
+declare const AXM_TEXT_TEMPLATE_IDS: {
+    readonly emailCompanyMaster: "c7100001-0001-4111-b111-010101010101";
+    readonly passwordReset: "c7100002-0001-4111-b111-020202020202";
+    readonly emailVerification: "c7100003-0001-4111-b111-030303030303";
+    readonly passwordChanged: "c7100004-0001-4111-b111-040404040404";
+    readonly ticketReceived: "c7100005-0001-4111-b111-050505050505";
+    readonly ticketResolved: "c7100006-0001-4111-b111-060606060606";
+    readonly employeeHappyBirthday: "c7100007-0001-4111-b111-070707070707";
+    readonly employeeJoiningCompany: "c7100008-0001-4111-b111-080808080808";
+    /** Document expired — daily notifier (email + in-app). */
+    readonly documentExpired: "c7100009-0001-4111-b111-090909090909";
+    /** Document near expiry — daily notifier (email + in-app). */
+    readonly documentNearExpiry: "c710000a-0001-4111-b111-0a0a0a0a0a0a";
+    /** Company print master — header, border, footer around `[content]`. */
+    readonly printCompanyMaster: "c710000b-0001-4111-b111-0b0b0b0b0b0b";
+    /** Default questionnaire print child (title, date, `{{sessionBody}}`). */
+    readonly questionnairePrint: "c710000c-0001-4111-b111-0c0c0c0c0c0c";
+};
+
+export { AXMPermissionsKeys, AXM_TEXT_TEMPLATE_CONTENT_SLOT, AXM_TEXT_TEMPLATE_IDS, AXM_TEXT_TEMPLATE_KIND, AXM_TEXT_TEMPLATE_MAX_PARENT_DEPTH, AXM_TEXT_TEMPLATE_PREVIEW_COMMAND_KEY, AXM_TEXT_TEMPLATE_PRINT_CHANNEL, AXM_TEXT_TEMPLATE_RENDER_COMMAND_KEY, AXM_TEXT_TEMPLATE_TENANT_MASTER_NAMESPACE, AXPContentDocumentsPermissionKeys, AXPContentManagementMenuKeys, RootConfig, collectTextTemplatePlaceholderNames, composeTextTemplateBodyChain, defaultShortDatePatternForLocale, defaultShortTimePatternForLocale, formatTextTemplateDate, formatTextTemplateMergeValues, formatTextTemplateNumber, parseTextTemplateDateValue, replaceTextTemplateContentSlot, replaceTextTemplatePlaceholders, resolveTextTemplateCalendar, resolveTextTemplateLocalizedString, textTemplateContainsContentSlot, validateTextTemplateContentSlots, validateTextTemplateParentChain };
+export type { AXMPromotionEntityModel, AXMSelectModel, AXMTextTemplateCalendarSystem, AXMTextTemplateChannelConfigureSettings, AXMTextTemplateChannelDefinition, AXMTextTemplateChannelDefinitionProvider, AXMTextTemplateChannelEditorType, AXMTextTemplateChannelsValue, AXMTextTemplateEntityModel, AXMTextTemplateKind, AXMTextTemplateParentChainNode, AXMTextTemplatePreviewRequest, AXMTextTemplatePreviewResult, AXMTextTemplateRegionalFormatContext, AXMTextTemplateRenderRequest, AXMTextTemplateRenderResult, AXMTextTemplateTokenFormatMeta };

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

@@ -0,0 +1,48 @@
+import * as i0 from '@angular/core';
+import { OnInit, WritableSignal, InjectionToken } from '@angular/core';
+import * as i1 from '@acorex-platform/framework-client/layout/widget-core';
+import * as i2 from '@acorex-platform/framework-client/core';
+import { AXMPromotionEntityModel, AXMTextTemplateChannelDefinitionProvider } from '@acorex-platform/module-content-management-client/contracts';
+export { AXMTextTemplateEntityModel, AXMTextTemplateKind, AXMTextTemplateParentChainNode, AXM_TEXT_TEMPLATE_CONTENT_SLOT, AXM_TEXT_TEMPLATE_KIND, AXM_TEXT_TEMPLATE_MAX_PARENT_DEPTH, AXM_TEXT_TEMPLATE_PREVIEW_COMMAND_KEY, AXM_TEXT_TEMPLATE_RENDER_COMMAND_KEY, collectTextTemplatePlaceholderNames, composeTextTemplateBodyChain, replaceTextTemplateContentSlot, replaceTextTemplatePlaceholders, resolveTextTemplateLocalizedString, textTemplateContainsContentSlot, validateTextTemplateContentSlots, validateTextTemplateParentChain } from '@acorex-platform/module-content-management-client/contracts';
+import { AXPMenuProvider, AXPMenuProviderContext, AXPSearchCommandProvider, AXPSearchResult, AXPSettingDefinitionProvider, AXPSettingDefinitionProviderContext } from '@acorex-platform/framework-client/common';
+import * as _acorex_platform_framework_client_layout_entity from '@acorex-platform/framework-client/layout/entity';
+
+declare class AXMContentManagementModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMContentManagementModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXMContentManagementModule, never, [typeof i1.AXPWidgetCoreModule, typeof i2.AXPComponentSlotModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AXMContentManagementModule>;
+}
+
+/** Registry / remote key for Nest `ContentManagement:TextTemplate:Render`. */
+declare const AXC_TEXT_TEMPLATE_RENDER_COMMAND_KEY: "ContentManagement:TextTemplate:Render";
+
+declare class AXMMenuProvider implements AXPMenuProvider {
+    private entityService;
+    provide(context: AXPMenuProviderContext): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMMenuProvider, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXMMenuProvider>;
+}
+
+declare class AXMSearchCommandProvider extends AXPSearchCommandProvider {
+    commands: AXPSearchResult[];
+}
+
+declare class AXMSettingProvider implements AXPSettingDefinitionProvider {
+    provide(context: AXPSettingDefinitionProviderContext): Promise<void>;
+}
+
+declare class AXMPromotionSlotComponent implements OnInit {
+    private readonly entityService;
+    location: string;
+    notificationChannelService: _acorex_platform_framework_client_layout_entity.EntityDataAccessor<any, any, any, Omit<any, "id">, any>;
+    listData: WritableSignal<AXMPromotionEntityModel[]>;
+    private fileStorage;
+    ngOnInit(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXMPromotionSlotComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AXMPromotionSlotComponent, "acorex-platform-promotion-slot", never, {}, {}, never, never, true, never>;
+}
+
+/** Multi-provider token – all providers are merged for available channels */
+declare const AXP_TEXT_TEMPLATE_CHANNEL_DEFINITION_PROVIDER: InjectionToken<AXMTextTemplateChannelDefinitionProvider>;
+
+export { AXC_TEXT_TEMPLATE_RENDER_COMMAND_KEY, AXMContentManagementModule, AXMMenuProvider, AXMPromotionSlotComponent, AXMSearchCommandProvider, AXMSettingProvider, AXP_TEXT_TEMPLATE_CHANNEL_DEFINITION_PROVIDER };