@smartsoft001-mobilems/models 2.101.0 → 2.103.0

package/README.md

@@ -15,7 +15,7 @@ import { Config, Page, MsFile, ArticleWidgetType } from '@smartsoft001-mobilems/
 | `ConfigPageType` | Page-type enum used by the config menu                            |
 | `ConfigMenuItem` | Union of menu-item shapes                                          |
 | `ITheme`         | Theme block of `Config` (colours, fonts, per-area flags)           |
-| `Page`           | CMS page — `IEntity<number>`; optional `slug`, `seo: PageSeo \| null`, `sections: PageSectionRaw[] \| null` (raw API shape — normalize before use) |
+| `Page`           | CMS page — `IEntity<number>`; optional `slug`, `seo: PageSeo \| null`, `sections: PageSectionRaw[] \| null` (raw API shape — normalize before use); `slides` may be missing or `null`; `image` / `backgroundImage` (`MsFile \| string \| null`) are the page images `GET page/:id` sends |
 | `PageSlide`      | Slide of a CMS page                                                |
 | `MsFile`         | Multimedia file — `IEntity<number>`                                |
 | `MsFileFromFeature` | Enum of file feature sources (image, audio, video, 3d, …)       |
@@ -45,8 +45,8 @@ arrays without `null`s, everything sorted by `position`, `position` always a num
 | `PageSectionCta`                | `position`, `target`                                                                    |
 | `PageSectionAppearance`         | `margin?`/`padding?: PageSectionSpacing \| null`, `background: PageSectionBackground \| null` |
 | `PageSectionSpacing`            | `top?`, `right?`, `bottom?`, `left?` — each `number` (CMS scale 0–12) or `null`          |
-| `PageSectionBackground`         | `color: string \| null`, `file?: PageSectionFile \| null`, `type?: 'image' \| 'video' \| string \| null` |
-| `PageSectionMedia`              | `position?`, `file: PageSectionFile \| null`, `type: 'image' \| 'video' \| null`         |
+| `PageSectionBackground`         | `color: string \| null` (only `#rgb`/`#rrggbb`/`#rrggbbaa` is used), `file?: PageSectionFile \| null`, `type?: 'image' \| 'video' \| 'audio' \| 'other' \| string \| null` |
+| `PageSectionMedia`              | `position?`, `file: PageSectionFile \| null`, `type: 'image' \| 'video' \| 'audio' \| 'other' \| null` (`null` → kind from the extension) |
 | `PageSectionFile`               | `filePath` (relative to the multimedia host, or an absolute CDN URL), `id?`, `extension?`, `altText?`, `fileName?` |
 | `PageSectionWidget`             | banner widgets: `search: PageSectionSearchWidget[]`, `counter: PageSectionCounterWidget[]` |
 | `PageSectionSearchWidget`       | `position`, `placeholder: string \| null`                                               |
@@ -54,7 +54,8 @@ arrays without `null`s, everything sorted by `position`, `position` always a num
 | `PageSectionTarget`             | Union of the targets below, discriminated by `targetType`; every target has `targetLabel?` |
 | `PageSectionLinkTarget`         | `targetType: 'link'`, `url` (`http(s)://`, `mailto:`, `tel:`, `#anchor` or internal path) |
 | `PageSectionPageTarget`         | `targetType: 'page'`, `page` (CMS page id)                                               |
-| `PageSectionDictionaryTarget`   | `targetType: 'dictionary'`, `dictionaryType: PageSectionDictionaryType`, `dictionary: number \| null` — an entry id (selected record) or `null`/missing = the whole dictionary (expanded by the angular `smart-mobilems-page-sections`) |
+| `PageSectionDictionaryTarget`   | `targetType: 'dictionary'`, `dictionaryType: PageSectionDictionaryType`, `dictionary: number \| null` — an entry id (selected record); `null`/missing = the whole dictionary (legacy form of `PageSectionDictionaryFilterTarget`, still supported) |
+| `PageSectionDictionaryFilterTarget` | `targetType: 'dictionary_filter'`, `dictionaryType: PageSectionDictionaryType`, `limit?: number \| null` (max blocks, integer `> 0`), `sort?: string \| null` (announced, ignored yet) — the whole dictionary, canonical API shape (expanded by the angular `smart-mobilems-page-sections`; never clickable itself). Future filter fields will be optional |
 | `PageSectionDictionaryType`     | `'creator' \| 'department' \| 'tag' \| 'cycle' \| string`                                 |
 | `PageSectionMuseumObjectTarget` | `targetType: 'museum_object'`, `object` (id)                                             |
 | `PageSectionCardTypeCodeTarget` | `targetType: 'card_type_code'`, `cardTypeCodes: number[]` (any matches)                  |
@@ -78,7 +79,7 @@ arrays without `null`s, everything sorted by `position`, `position` always a num
   widgets: `IArticleWidgetText`, `IArticleWidgetImage`, `IArticleWidgetMedia`, `IArticleWidgetVideo`,
   `IArticleWidgetAudio`, `IArticleWidgetGalleryImage`, `IArticleWidgetGalleryArticle`,
   `IArticleWidgetGalleryObject`
-- Shared descriptors: `IAuthor`, `ICreator`, `IKeyword`, `ICycle`, `ICopyrights`, `MenuItem`, `ITab`
+- Shared descriptors: `IAuthor`, `ICreator`, `IKeyword`, `ICycle`, `ICopyrights`, `MenuItem`, `ITab` (`id`, `label`, optional `count` for search tabs)
 
 `WidgetComponent` in [`@smartsoft001-mobilems/angular`](../angular/README.md) maps an
 `ArticleWidgetType` to the component that renders it; a new widget type is an `IArticleWidget`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartsoft001-mobilems/models",
-  "version": "2.101.0",
+  "version": "2.103.0",
   "types": "./src/index.d.ts",
   "main": "./src/index.js",
   "type": "commonjs"

package/src/lib/entities/page-section.entity.d.ts

@@ -33,10 +33,7 @@ export interface PageSectionPageTarget {
     /** CMS page id. */
     page: number;
 }
-/**
- * Dictionary kinds the CMS offers (`cycle` announced, not in the CMS yet);
- * others may come later.
- */
+/** Dictionary kinds the CMS offers; others may come later. */
 export type PageSectionDictionaryType = 'creator' | 'department' | 'tag' | 'cycle' | (string & {});
 export interface PageSectionDictionaryTarget {
     targetType: 'dictionary';
@@ -45,11 +42,40 @@ export interface PageSectionDictionaryTarget {
     dictionaryType: PageSectionDictionaryType;
     /**
      * Dictionary entry id (a selected record). `null` — or a missing field —
-     * means the whole dictionary: `smart-mobilems-page-sections` expands such a
-     * block into one block per entry (`expandDictionaryBlocks`).
+     * means the whole dictionary (legacy form of
+     * `PageSectionDictionaryFilterTarget`, still supported):
+     * `smart-mobilems-page-sections` expands such a block into one block per
+     * entry (`expandDictionaryBlocks`).
      */
     dictionary: number | null;
 }
+/**
+ * A whole dictionary (CMS mode "a dictionary" as opposed to "selected
+ * records") — the canonical shape sent by the API:
+ * `{ targetType: 'dictionary_filter', dictionaryType: 'cycle' }`.
+ * `smart-mobilems-page-sections` expands such a block into one block per
+ * entry, each with a `PageSectionDictionaryTarget` (`expandDictionaryBlocks`);
+ * not expanded it is never clickable.
+ *
+ * The backend announced a filter configuration for this target; every such
+ * field is optional, so new ones do not break the contract.
+ */
+export interface PageSectionDictionaryFilterTarget {
+    targetType: 'dictionary_filter';
+    targetLabel?: string | null;
+    /** Dictionary kind, e.g. `cycle`. */
+    dictionaryType: PageSectionDictionaryType;
+    /**
+     * Max blocks produced from the dictionary — applied when it is an integer
+     * `> 0`, otherwise ignored.
+     */
+    limit?: number | null;
+    /**
+     * Announced (e.g. newest/oldest first) — not interpreted yet, entries keep
+     * the API order.
+     */
+    sort?: string | null;
+}
 export interface PageSectionMuseumObjectTarget {
     targetType: 'museum_object';
     targetLabel?: string | null;
@@ -72,7 +98,7 @@ export interface PageSectionModuleTarget {
     targetLabel?: string | null;
     [field: string]: unknown;
 }
-export type PageSectionTarget = PageSectionLinkTarget | PageSectionPageTarget | PageSectionDictionaryTarget | PageSectionMuseumObjectTarget | PageSectionCardTypeCodeTarget | PageSectionModuleTarget;
+export type PageSectionTarget = PageSectionLinkTarget | PageSectionPageTarget | PageSectionDictionaryTarget | PageSectionDictionaryFilterTarget | PageSectionMuseumObjectTarget | PageSectionCardTypeCodeTarget | PageSectionModuleTarget;
 export interface PageSectionFile {
     id?: number;
     /**
@@ -87,7 +113,8 @@ export interface PageSectionFile {
 export interface PageSectionMedia {
     position?: number;
     file: PageSectionFile | null;
-    type: 'image' | 'video' | null;
+    /** File kind from the API; `null`/missing → guessed from the extension. */
+    type: 'image' | 'video' | 'audio' | 'other' | null;
 }
 /** `media` of a block: the background and an optional audio/video file. */
 export interface PageSectionBlockMedia {
@@ -127,7 +154,10 @@ export interface PageSectionSpacing {
 export interface PageSectionBackground {
     color: string | null;
     file?: PageSectionFile | null;
-    /** `image`/`video`; any other string is accepted (and treated as image). */
+    /**
+     * `image`/`video`/`audio`/`other`; only `image`, `null` or an unknown string
+     * give a background image.
+     */
     type?: 'image' | 'video' | (string & {}) | null;
 }
 export interface PageSectionAppearance {

package/src/lib/entities/page.entity.d.ts

@@ -1,10 +1,12 @@
 import { IEntity } from '@smartsoft001/domain-core';
+import { MsFile } from './file.entity';
 import { PageSectionRaw, PageSeo } from './page-section.entity';
 export declare class Page implements IEntity<number> {
     id: number;
     title: string;
     content: any;
-    slides: Array<PageSlide>;
+    /** Empty or missing on most pages; the API may also send `null`. */
+    slides?: Array<PageSlide> | null;
     slug?: string;
     seo?: PageSeo | null;
     /**
@@ -13,6 +15,9 @@ export declare class Page implements IEntity<number> {
      * `smart-mobilems-page-sections` does it itself.
      */
     sections?: PageSectionRaw[] | null;
+    /** Page image sent by `GET page/:id`, as a file object or a ready path. */
+    image?: MsFile | string | null;
+    backgroundImage?: MsFile | string | null;
 }
 export declare class PageSlide {
     id: number;

package/src/lib/entities/page.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"page.entity.js","sourceRoot":"","sources":["../../../../../../../packages/shared/models/src/lib/entities/page.entity.ts"],"names":[],"mappings":";;;;AACA,iDAAoD;AAK7C,IAAM,IAAI,GAAV,MAAM,IAAI;CA0BhB,CAAA;AA1BY,oBAAI;AAIf;IADC,IAAA,cAAK,GAAE;;mCACO;AAGf;IADC,IAAA,cAAK,GAAE;;qCACK;AAGb;IADC,IAAA,cAAK,GAAE;sCACC,KAAK;oCAAY;eAVf,IAAI;IADhB,IAAA,cAAK,GAAE;GACK,IAAI,CA0BhB;AAGM,IAAM,SAAS,GAAf,MAAM,SAAS;CAkBrB,CAAA;AAlBY,8BAAS;AAEpB;IADC,IAAA,cAAK,GAAE;;qCACI;AAGZ;IADC,IAAA,cAAK,GAAE;;wCACO;AAGf;IADC,IAAA,cAAK,GAAE;;+CACwB;AAGhC;IADC,IAAA,cAAK,GAAE;;+CACc;AAGtB;IADC,IAAA,cAAK,GAAE;;8CACa;AAGrB;IADC,IAAA,cAAK,GAAE;;8CACa;oBAjBV,SAAS;IADrB,IAAA,cAAK,GAAE;GACK,SAAS,CAkBrB"}
+{"version":3,"file":"page.entity.js","sourceRoot":"","sources":["../../../../../../../packages/shared/models/src/lib/entities/page.entity.ts"],"names":[],"mappings":";;;;AACA,iDAAoD;AAM7C,IAAM,IAAI,GAAV,MAAM,IAAI;CAgChB,CAAA;AAhCY,oBAAI;AAIf;IADC,IAAA,cAAK,GAAE;;mCACO;AAGf;IADC,IAAA,cAAK,GAAE;;qCACK;AAIb;IADC,IAAA,cAAK,GAAE;sCACC,KAAK;oCAAmB;eAXtB,IAAI;IADhB,IAAA,cAAK,GAAE;GACK,IAAI,CAgChB;AAGM,IAAM,SAAS,GAAf,MAAM,SAAS;CAkBrB,CAAA;AAlBY,8BAAS;AAEpB;IADC,IAAA,cAAK,GAAE;;qCACI;AAGZ;IADC,IAAA,cAAK,GAAE;;wCACO;AAGf;IADC,IAAA,cAAK,GAAE;;+CACwB;AAGhC;IADC,IAAA,cAAK,GAAE;;+CACc;AAGtB;IADC,IAAA,cAAK,GAAE;;8CACa;AAGrB;IADC,IAAA,cAAK,GAAE;;8CACa;oBAjBV,SAAS;IADrB,IAAA,cAAK,GAAE;GACK,SAAS,CAkBrB"}

package/src/lib/interfaces.d.ts

@@ -133,4 +133,6 @@ export type MenuItem = {
 export interface ITab {
     id: string;
     label: string;
+    /** Result count shown next to the label (search tabs). */
+    count?: number;
 }