@smartsoft001-mobilems/models 2.95.0 → 2.97.0

package/README.md

@@ -15,11 +15,33 @@ 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 static page — `IEntity<number>`                                |
+| `Page`           | CMS page — `IEntity<number>`; optional `slug`, `seo: PageSeo \| null`, `sections: PageSection[] \| null` |
 | `PageSlide`      | Slide of a CMS page                                                |
 | `MsFile`         | Multimedia file — `IEntity<number>`                                |
 | `MsFileFromFeature` | Enum of file feature sources (image, audio, video, 3d, …)       |
 
+## Page sections
+
+Dynamic CMS page sections — `Page.sections`, returned by `GET page/<id>` / `GET page/slug/<slug>` and
+rendered by `PageSectionsComponent` (`smart-mobilems-page-sections`) in
+[`@smartsoft001-mobilems/angular`](../angular/README.md). Fields the API may send as `null` are typed
+as such; `grid`, `margin` and `padding` are `unknown` (not interpreted yet).
+
+| Export                          | Shape                                                                                   |
+| ------------------------------- | --------------------------------------------------------------------------------------- |
+| `PageSection`                   | `type`, `theme` (component key `type/theme`), `position`, `appearance`, `content`, `blocks`, `cta`, `grid?` |
+| `PageSectionContent`            | `title?`, `lead?` (HTML), `description?` (HTML)                                         |
+| `PageSectionBlock`              | `position`, `content`, `media: { background: PageSectionMedia \| null } \| null`, `target`, `grid?` |
+| `PageSectionCta`                | `position`, `target`                                                                    |
+| `PageSectionAppearance`         | `background: { color, file?, type? } \| null`, `margin?`, `padding?`                     |
+| `PageSectionMedia`              | `position?`, `file: PageSectionFile \| null`, `type: 'image' \| 'video' \| null`         |
+| `PageSectionFile`               | `filePath` (relative to the API host), `id?`, `extension?`, `altText?`, `fileName?`     |
+| `PageSectionTarget`             | Union of the three targets below, discriminated by `targetType`                         |
+| `PageSectionLinkTarget`         | `targetType: 'link'`, `url` (`http(s)://`, `#anchor` or internal path), `targetLabel?`  |
+| `PageSectionDictionaryTarget`   | `targetType: 'dictionary'`, `dictionaryType` (e.g. `creator`), `dictionary` (id), `targetLabel?` |
+| `PageSectionMuseumObjectTarget` | `targetType: 'museum_object'`, `object` (id), `targetLabel?`                            |
+| `PageSeo`                       | `title?`, `description?` — SEO fields of a `Page`                                       |
+
 ## User
 
 `IUser`, `IUserInfo`, `IUserRegister`, `IUserModify`, `ILoginResponse` — the API-payload shapes.

package/package.json

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

package/src/lib/entities/index.d.ts

@@ -1,3 +1,4 @@
 export * from './file.entity';
 export * from './page.entity';
+export * from './page-section.entity';
 export * from './user.entity';

package/src/lib/entities/index.js

@@ -3,5 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./file.entity"), exports);
 tslib_1.__exportStar(require("./page.entity"), exports);
+tslib_1.__exportStar(require("./page-section.entity"), exports);
 tslib_1.__exportStar(require("./user.entity"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/entities/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/shared/models/src/lib/entities/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,wDAA8B;AAC9B,wDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/shared/models/src/lib/entities/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,wDAA8B;AAC9B,gEAAsC;AACtC,wDAA8B"}

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

@@ -0,0 +1,87 @@
+/**
+ * Dynamic CMS page sections — `sections` of a `Page` returned by
+ * `GET page/<id>` / `GET page/slug/<slug>`.
+ *
+ * Every field the API may send as `null` is typed as such. `grid`, `margin`
+ * and `padding` are not interpreted by the framework yet, hence `unknown`.
+ */
+export interface PageSectionContent {
+    title?: string | null;
+    /** HTML. */
+    lead?: string | null;
+    /** HTML. */
+    description?: string | null;
+}
+export interface PageSectionLinkTarget {
+    targetType: 'link';
+    targetLabel?: string | null;
+    /** `http(s)://…` (external), `#anchor` or an internal path. */
+    url: string | null;
+}
+export interface PageSectionDictionaryTarget {
+    targetType: 'dictionary';
+    targetLabel?: string | null;
+    /** Dictionary kind, e.g. `creator`. */
+    dictionaryType: string;
+    /** Dictionary entry id. */
+    dictionary: number;
+}
+export interface PageSectionMuseumObjectTarget {
+    targetType: 'museum_object';
+    targetLabel?: string | null;
+    /** Museum object id. */
+    object: number;
+}
+export type PageSectionTarget = PageSectionLinkTarget | PageSectionDictionaryTarget | PageSectionMuseumObjectTarget;
+export interface PageSectionFile {
+    id?: number;
+    /** Relative to the API host, e.g. `/uploads/media/…`. */
+    filePath: string;
+    extension?: string | null;
+    altText?: string | null;
+    fileName?: string | null;
+}
+export interface PageSectionMedia {
+    position?: number;
+    file: PageSectionFile | null;
+    type: 'image' | 'video' | null;
+}
+export interface PageSectionBlock {
+    position: number;
+    grid?: unknown;
+    content: PageSectionContent | null;
+    media: {
+        background: PageSectionMedia | null;
+    } | null;
+    target: PageSectionTarget | null;
+}
+export interface PageSectionCta {
+    position: number;
+    target: PageSectionTarget | null;
+}
+export interface PageSectionAppearance {
+    margin?: unknown;
+    padding?: unknown;
+    background: {
+        color: string | null;
+        file?: PageSectionFile | null;
+        type?: string | null;
+    } | null;
+}
+export interface PageSection {
+    /** Section kind, e.g. `slider`, `tile_collection`, `banner`. */
+    type: string;
+    /** Visual variant of the `type`, e.g. `carousel`, `cards`. */
+    theme: string;
+    appearance: PageSectionAppearance | null;
+    position: number;
+    grid?: unknown;
+    content: PageSectionContent | null;
+    blocks: PageSectionBlock[];
+    cta: PageSectionCta[];
+}
+/** SEO fields of a CMS page; every field may be `null`. */
+export interface PageSeo {
+    title?: string | null;
+    description?: string | null;
+}

package/src/lib/entities/page-section.entity.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * Dynamic CMS page sections — `sections` of a `Page` returned by
+ * `GET page/<id>` / `GET page/slug/<slug>`.
+ *
+ * Every field the API may send as `null` is typed as such. `grid`, `margin`
+ * and `padding` are not interpreted by the framework yet, hence `unknown`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=page-section.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"page-section.entity.js","sourceRoot":"","sources":["../../../../../../../packages/shared/models/src/lib/entities/page-section.entity.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}

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

@@ -1,9 +1,14 @@
 import { IEntity } from '@smartsoft001/domain-core';
+import { PageSection, PageSeo } from './page-section.entity';
 export declare class Page implements IEntity<number> {
     id: number;
     title: string;
     content: any;
     slides: Array<PageSlide>;
+    slug?: string;
+    seo?: PageSeo | null;
+    /** Dynamic sections, rendered by `smart-mobilems-page-sections`. */
+    sections?: PageSection[] | 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;AAG7C,IAAM,IAAI,GAAV,MAAM,IAAI;CAWhB,CAAA;AAXY,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,CAWhB;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;AAK7C,IAAM,IAAI,GAAV,MAAM,IAAI;CAsBhB,CAAA;AAtBY,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,CAsBhB;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"}