@smartsoft001-mobilems/public-collections-shell-angular 2.119.0 → 2.121.0

package/types/smartsoft001-mobilems-public-collections-shell-angular.d.ts

@@ -1,17 +1,21 @@
 import * as i0 from '@angular/core';
-import { TemplateRef, ModuleWithProviders, Signal } from '@angular/core';
+import { TemplateRef, ModuleWithProviders, Signal, WritableSignal } from '@angular/core';
 import * as _smartsoft001_crud_shell_angular from '@smartsoft001/crud-shell-angular';
-import { ICrudModuleOptionsWithoutRoutng, CrudFacade, CrudListPageBaseComponent, CrudItemPageBaseComponent, State as State$1, CrudService } from '@smartsoft001/crud-shell-angular';
+import { ICrudModuleOptionsWithoutRoutng, CrudFacade, CrudListPageBaseComponent, CrudItemPageBaseComponent, State as State$1, ICrudFilter, CrudService } from '@smartsoft001/crud-shell-angular';
 import { IEntity } from '@smartsoft001/domain-core';
 import * as i1$1 from '@smartsoft001-mobilems/angular';
-import { FiltersBaseComponent, CrudBaseService, SeoService, TranslationService } from '@smartsoft001-mobilems/angular';
+import { FiltersBaseComponent, CrudBaseService, SeoService, TranslationService, ICatalog, ICatalogLoadMore, IDictionaryEntry, ICatalogOptions, ICycleTagSearchOptions, ICatalogSort, FileUrlMode, ISeoMetadata } from '@smartsoft001-mobilems/angular';
 import * as i1 from '@angular/common';
-import { PublicCollection } from '@smartsoft001-mobilems/public-collections-domain';
+import { PublicCollection, PublicCollectionItemType } from '@smartsoft001-mobilems/public-collections-domain';
 import * as dist_packages_public_collections_domain_src from 'dist/packages/public-collections/domain/src';
 import * as _angular_router from '@angular/router';
 import { ActivatedRoute } from '@angular/router';
 import * as _ngrx_store from '@ngrx/store';
 import { Action } from '@ngrx/store';
+import { ListMode } from '@smartsoft001/angular';
+import { Article } from '@smartsoft001-mobilems/articles-domain';
+import { MsObject } from '@smartsoft001-mobilems/objects-domain';
+import { Observable } from 'rxjs';
 
 declare class FiltersComponent extends FiltersBaseComponent<PublicCollection> {
     static ɵfac: i0.ɵɵFactoryDeclaration<FiltersComponent, never>;
@@ -125,10 +129,358 @@ declare function getReducer(): (state: any, action: Action) => State$1<any> | {
 
 declare const getPublicCollectionsState: _ngrx_store.MemoizedSelector<object, State, _ngrx_store.DefaultProjectorFn<State>>;
 
+interface IPublicCollectionPaginator {
+    currentPage: number;
+    maxPerPage: number;
+    totalItemsCount: number;
+    totalPagesCount: number;
+}
+interface IPublicCollectionPage extends PublicCollection {
+    paginatorDetails?: IPublicCollectionPaginator;
+    publicationDate?: string | null;
+    cycles?: {
+        id: number;
+        name: string;
+    }[] | null;
+}
+/** How many related articles a collection page shows. */
+declare const PUBLIC_COLLECTION_RELATED_ARTICLES_LIMIT = 20;
+declare class PublicCollectionItemsService extends PublicCollectionsService {
+    /**
+     * Status of the last failed page load. `getItems` yields `null` both for no
+     * data and for an error, so without it a page cannot tell a 404 from a load
+     * in progress.
+     */
+    readonly loadErrorStatus: WritableSignal<number | null>;
+    /** A collection page is loading (paging, sorting and "load more" go through `getItems`). */
+    readonly loading: WritableSignal<boolean>;
+    /**
+     * Fetches a page of the collection items. Call in an injection context.
+     * The URL (parameter order included) is the transfer cache key: keep it as is.
+     */
+    getItems(collectionId: string, filter: Signal<ICrudFilter>): Signal<IPublicCollectionPage | null>;
+    /**
+     * Articles related to the collection. The API answers 404
+     * (`NO_RESULTS_FOR_GIVEN_QUERY`) when there are none; that, like any error,
+     * is an empty list.
+     */
+    getRelatedArticles(collectionId: string): Observable<Article[]>;
+    private collectionItemsBuildUrl;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PublicCollectionItemsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PublicCollectionItemsService>;
+}
+
 declare const SERVICES: (typeof PublicCollectionsService | {
     provide: typeof CrudService;
     useClass: typeof PublicCollectionsService;
 })[];
 
-export { ComponentsModule, FiltersComponent, ListComponent, PublicCollectionsFacade, PublicCollectionsItemComponent, PublicCollectionsListComponent, PublicCollectionsModule, PublicCollectionsService, PublicCollectionsSharedModule, SERVICES, getPublicCollectionsState, getReducer, initialState };
-export type { State };
+/**
+ * Filter defaults of the collections list (Muzeum Podlasia): a 3x4 grid, 12
+ * collections per page. `sortBy`/`sortDesc` match the toolbar's default label
+ * ('Name A to Z'); without them `CrudBaseService` sends `sort=random`.
+ */
+declare const COLLECTIONS_CATALOG_DEFAULTS: ICrudFilter;
+/**
+ * Query key of the theme tags — cycles (`filter[cycles][]=<id>`; checked on
+ * the API: the forms with and without `[]` filter the same, an empty result
+ * is a 404).
+ */
+declare const COLLECTIONS_CYCLES_FILTER_KEY = "cycles";
+/**
+ * Cleans a persisted collections filter: the collections API ignores tags of
+ * the former `Keyword` dictionary, so they are not restored as an invisible
+ * filter.
+ */
+declare function dropLegacyCollectionKeywords(saved: ICrudFilter): ICrudFilter;
+/** List SEO: `<title> - <site>`, a raw description and the canonical url. */
+interface ICollectionsCatalogSeo {
+    /** Translation key of the page title, e.g. `PAGE_TITLES.collections`. */
+    titleKey: string;
+    /** Translation key of the description — not capitalised. */
+    descriptionKey: string;
+    /** Translation key of the site name. Default `MODEL.mainTitle`. */
+    siteNameKey?: string;
+    /** Canonical url of the list, e.g. `/kolekcje`. */
+    url: string;
+}
+declare const COLLECTIONS_CATALOG_SEO: ICollectionsCatalogSeo;
+/** Focus target and live-region message of „więcej ↓” (load more). */
+interface ICollectionsCatalogLoadMore {
+    /** Cards inside `#listContainer`; the first appended one gets the focus. */
+    itemSelector?: string;
+    /** Translation key announced after a page is appended (`{ count }`). */
+    loadedMoreKey?: string;
+}
+interface ICollectionsCatalogOptions extends Partial<Omit<ICatalogOptions, 'facade'>> {
+    /** Applied on creation, skipped in a search tab; `null` — no SEO. */
+    seo?: ICollectionsCatalogSeo | null;
+    /** Opt-in `Cycle` tag dictionary of the tag bar (requests the API). */
+    cycleTags?: ICycleTagSearchOptions;
+    loadMore?: ICollectionsCatalogLoadMore;
+}
+/**
+ * Base of a collections list page on the shared catalog engine
+ * (`createCatalog`): first read (also in SSR when the route carries the
+ * filter), persistence, sort/size/page, the read guard, cycle tags,
+ * „więcej ↓” and the list SEO. The page keeps its template.
+ *
+ * ```ts
+ * export class ListComponent extends CollectionsCatalogBaseComponent {
+ *   constructor() {
+ *     super({ cycleTags: { debounceMs: 300 } });
+ *   }
+ * }
+ * ```
+ *
+ * A `#listContainer` element in the template is scrolled to after a page
+ * change from the bottom pagination and holds the cards focused by load more.
+ */
+declare abstract class CollectionsCatalogBaseComponent extends PublicCollectionsListComponent {
+    readonly ListMode: typeof ListMode;
+    protected readonly catalog: ICatalog;
+    readonly isBrowser: Signal<boolean>;
+    /** The route set the filter, so the list is read and rendered in SSR too. */
+    readonly routeList: Signal<boolean>;
+    readonly listMode: Signal<ListMode>;
+    readonly searchEnabled: Signal<boolean | undefined>;
+    readonly barPhrase: Signal<string>;
+    readonly isLoading: Signal<boolean>;
+    readonly hasError: Signal<unknown>;
+    readonly totalCount: Signal<number>;
+    /** `name-desc` style key for the toolbar. */
+    readonly sortKey: Signal<string | undefined>;
+    readonly selectedPage: Signal<number>;
+    /** „więcej ↓” on mobile (2290:10510) — previous pages' cards + the current. */
+    readonly loadMore: ICatalogLoadMore<PublicCollection>;
+    /** Screen reader message after cards were appended. */
+    readonly loadMoreStatus: WritableSignal<string>;
+    /** Phrase of the „Search tags” field (the `q` of the `Cycle` dictionary). */
+    readonly tagQuery: WritableSignal<string>;
+    /** Theme tags of the filter bar; `[]` without the `cycleTags` option. */
+    readonly cycleTags: Signal<IDictionaryEntry[]>;
+    /** Selected cycle ids. */
+    readonly selectedTagIds: Signal<(number | null)[]>;
+    /**
+     * Bar chips: selected cycles always first, then the rest of the result — a
+     * cycle picked on a tile stays visible and can be unselected even when the
+     * „Search tags” phrase does not return it.
+     */
+    readonly tagChips: Signal<IDictionaryEntry[]>;
+    private readonly collectionsCatalogTranslate;
+    private readonly collectionsCatalogSeoService;
+    private readonly collectionsCatalogBrowser;
+    private readonly collectionsCatalogTimeouts;
+    private readonly collectionsCatalogListContainer;
+    private collectionsCatalogScrollAfterLoad;
+    /**
+     * Selected cycles — the `cycles` item of the current filter, numeric ids
+     * without repeats (`"7"` from a deep link = `7` from the dictionary,
+     * review MOB-1815).
+     */
+    private readonly collectionsCatalogSelectedTags;
+    protected constructor(options?: ICollectionsCatalogOptions);
+    /** The list root element (`#listContainer`). */
+    protected get listContainerElement(): HTMLElement | undefined;
+    retryLoad(): void;
+    pageChange(page: number): void;
+    /** Page change from the bottom pagination — scrolls to the list once loaded. */
+    bottomPageChange(page: number): void;
+    onSortChange(sort: ICatalogSort): void;
+    /** Sort by key (`name-desc`, `random`). */
+    sortChange(key: string): void;
+    onLimitChange(limit: number | string): void;
+    /**
+     * Toggles one cycle in the `cycles` item (filter bar and tile pills);
+     * unselecting the last one removes the whole query item. Compared by the
+     * normalised id: a click on `7` also removes `"7"` from a deep link
+     * instead of adding a second filter (review MOB-1815); an added cycle is
+     * stored with its numeric id.
+     */
+    onTagToggle(entry: IDictionaryEntry): void;
+    /**
+     * Search from the filter bar. In the catalog it patches the filter; in a
+     * search tab the phrase lives in the address (MOB-1818) — a new one opens
+     * `/wyszukaj/:text/kolekcje`, a blank one `/kolekcje` with the other filters.
+     */
+    onFilterBarSearch(phrase: string): void;
+    onListModeChange(mode: ListMode): void;
+    clearAllFilters(): void;
+    /**
+     * Full list meta (title, description, canonical, og), not in a search tab —
+     * there the search page sets them, and the canonical of the list must not
+     * point at a phrase url. The description goes out as translated.
+     */
+    protected applyListSeo(seo: ICollectionsCatalogSeo): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CollectionsCatalogBaseComponent, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CollectionsCatalogBaseComponent, never, never, {}, {}, never, never, true, never>;
+}
+
+/** Local filter of a collection page (Muzeum Podlasia): 20 objects per page, unsorted. */
+declare const COLLECTION_DETAILS_DEFAULTS: ICrudFilter;
+/** An item of a collection page — an object or an article. */
+type CollectionDetailsItem = ({
+    type: PublicCollectionItemType.object;
+    data: MsObject;
+} | {
+    type: PublicCollectionItemType.article;
+    data: Article;
+}) & {
+    id: string;
+};
+/** A related article link: the id and its plain-text title. */
+interface ICollectionRelatedArticle {
+    id: string;
+    title: string;
+}
+/** Focus target and live-region message of „więcej ↓” (load more). */
+interface ICollectionDetailsLoadMore {
+    /** Cards inside `#listContainer`; the first appended one gets the focus. */
+    itemSelector?: string;
+    /** Translation key announced after a page is appended (`{ count }`). */
+    loadedMoreKey?: string;
+}
+interface ICollectionDetailsOptions {
+    /** Initial local filter. Default `COLLECTION_DETAILS_DEFAULTS`. */
+    defaults?: ICrudFilter;
+    /** `StorageService` key of the grid/list mode — shared with `/obiekty` on purpose. */
+    listModeKey?: string;
+    /** Below this `innerWidth` the mode is forced and the toggle ignored. Default `768`. */
+    mobileBreakpoint?: number;
+    /** The mode forced below the breakpoint. Default `ListMode.masonryGrid`. */
+    mobileListMode?: ListMode;
+    /** Translation key of the site name in the titles. Default `MODEL.mainTitle`. */
+    siteNameKey?: string;
+    /** `FileUrlService` mode of the hero image. Default `noCache` (MOB-1564, MOB-1850). */
+    heroImageMode?: FileUrlMode;
+    /** Opt-in related articles (requests `search/Article`). Default `false`. */
+    relatedArticles?: boolean;
+    loadMore?: ICollectionDetailsLoadMore;
+}
+/**
+ * Base of a collection page: the collection with a locally paged list of its
+ * items (`PublicCollectionItemsService.getItems`), sort/size/page, 404 vs
+ * other load errors, SEO (also in SSR), hero image and meta, opt-in related
+ * articles, „więcej ↓” and the grid/list mode. The page keeps its template.
+ *
+ * ```ts
+ * // Muzeum Podlasia
+ * export class ItemComponent extends CollectionDetailsBaseComponent {
+ *   constructor() {
+ *     super({ relatedArticles: true });
+ *   }
+ * }
+ * ```
+ *
+ * A `#listContainer` element in the template is scrolled to after a page
+ * change from the bottom pagination and holds the cards focused by load more.
+ */
+declare abstract class CollectionDetailsBaseComponent extends PublicCollectionsItemComponent {
+    protected readonly collectionDetailsService: PublicCollectionItemsService;
+    private readonly collectionDetailsSeo;
+    private readonly collectionDetailsFileUrl;
+    private readonly collectionDetailsStorage;
+    private readonly collectionDetailsTranslate;
+    private readonly collectionDetailsLocale;
+    private readonly collectionDetailsDocument;
+    private readonly collectionDetailsBrowser;
+    private readonly collectionDetailsTimeouts;
+    private readonly collectionDetailsListContainer;
+    private readonly collectionDetailsMasonry;
+    private readonly collectionDetailsOptions;
+    private collectionDetailsScrollAfterLoad;
+    /** The collection read by the facade or a page of objects by the service. */
+    readonly isLoading: Signal<boolean>;
+    /** Mode of the objects list — tiles (masonry) or a vertical list. */
+    readonly listMode: WritableSignal<ListMode>;
+    /** Local filter; a new value triggers a read of the items. */
+    readonly localFilter: WritableSignal<ICrudFilter>;
+    /** The collection with the current page of items. */
+    readonly data: Signal<IPublicCollectionPage | null>;
+    /** The current filter as a toolbar option key (e.g. `name-desc`). */
+    readonly toolbarSortKey: Signal<string>;
+    /**
+     * The hero straight from the real file (`noCache` = `filePath` without the
+     * extension swap). `FileUrlService.get()` in `cache` mode forces `.jpg` for
+     * paths outside `media/dictionaries`/`media/articles`, and the CDN has no
+     * preset for `entry_collections` — the `.jpg` ended in 404 /
+     * ERR_BLOCKED_BY_ORB (MOB-1564), and the real `.png` came only after
+     * hydration through `(error)` (Lighthouse: collection LCP 20 s, MOB-1850).
+     */
+    readonly heroImageSrc: Signal<string>;
+    readonly description: Signal<string>;
+    /**
+     * „author | date” row under the hero title. `undefined` when there is
+     * nothing to show — the hero then renders no paragraph at all.
+     */
+    readonly heroMeta: Signal<string | undefined>;
+    /** The API answered 404 — the page shows „not found” instead of nothing. */
+    readonly notFound: Signal<boolean>;
+    /** Other load errors — a message with a retry. */
+    readonly hasLoadError: Signal<boolean>;
+    readonly selectedPage: Signal<number>;
+    readonly totalCount: Signal<number>;
+    readonly list: Signal<CollectionDetailsItem[]>;
+    /** The collection's objects — the grid under „Objects in the collection”. */
+    readonly objectItems: Signal<CollectionDetailsItem[]>;
+    /**
+     * „Unusual stories and articles related to the collection” — articles from
+     * `search/Article` with the `relatedEntryCollections` filter (MOB-1601),
+     * not from the collection items. The API title may be HTML (`<p>…</p>`)
+     * with entities (`&nbsp;`, `&amp;`), so the link gets decoded plain text.
+     * `[]` and no request without the `relatedArticles` option.
+     */
+    readonly relatedArticles: Signal<ICollectionRelatedArticle[]>;
+    /** Screen reader message after cards were appended („więcej ↓”). */
+    readonly loadMoreStatus: WritableSignal<string>;
+    /**
+     * „więcej ↓” on mobile („More objects” 2290:10482) — objects of the
+     * previous pages + the current one; the focus moves to the first appended
+     * card.
+     */
+    readonly loadMore: ICatalogLoadMore<CollectionDetailsItem>;
+    protected constructor(options?: ICollectionDetailsOptions);
+    onListMode(value: ListMode): void;
+    onToolbarSortChange({ by, desc }: ICatalogSort): void;
+    /** Sort by a dropdown key (`name-desc`, `random`). */
+    sortChange(key: string): void;
+    /** Repeats the last request — a new filter reference forces another call. */
+    retryLoad(): void;
+    limitChange(value: number | string): void;
+    pageChange(page: number): void;
+    /** Page change from the bottom pagination — scrolls to the list once loaded. */
+    bottomPageChange(page: number): void;
+    isObject(type: PublicCollectionItemType): boolean;
+    $MsObject(item: unknown): MsObject;
+    /** SEO of the collection: `<title> - <site>`, description, image alt. */
+    protected buildSeoMetadata(item: IPublicCollectionPage): ISeoMetadata;
+    private get collectionDetailsSiteNameKey();
+    private collectionDetailsIsMobile;
+    private collectionDetailsInitListMode;
+    private collectionDetailsFetchSsrSeo;
+    private collectionDetailsFormatDate;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CollectionDetailsBaseComponent, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CollectionDetailsBaseComponent, never, never, {}, {}, never, never, true, never>;
+}
+
+/** How long (ms) the "link copied" message stays after a click. */
+declare const COLLECTION_SHARE_COPIED_TIMEOUT = 3000;
+/**
+ * Logic of the "Share collection" button: the native share sheet, or a
+ * clipboard copy with a "link copied" flag when the browser has no share sheet.
+ * The template stays in the app.
+ */
+declare abstract class CollectionShareButtonBaseComponent {
+    private readonly collectionShareButtonPlatformId;
+    private readonly collectionShareButtonDocument;
+    private readonly collectionShareButtonTimeouts;
+    protected readonly copied: i0.WritableSignal<boolean>;
+    /** How long (ms) "copied" stays on; overridable, read inside `share`. */
+    protected readonly collectionShareButtonCopiedTimeout: number;
+    protected share(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CollectionShareButtonBaseComponent, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CollectionShareButtonBaseComponent, never, never, {}, {}, never, never, true, never>;
+}
+
+export { COLLECTIONS_CATALOG_DEFAULTS, COLLECTIONS_CATALOG_SEO, COLLECTIONS_CYCLES_FILTER_KEY, COLLECTION_DETAILS_DEFAULTS, COLLECTION_SHARE_COPIED_TIMEOUT, CollectionDetailsBaseComponent, CollectionShareButtonBaseComponent, CollectionsCatalogBaseComponent, ComponentsModule, FiltersComponent, ListComponent, PUBLIC_COLLECTION_RELATED_ARTICLES_LIMIT, PublicCollectionItemsService, PublicCollectionsFacade, PublicCollectionsItemComponent, PublicCollectionsListComponent, PublicCollectionsModule, PublicCollectionsService, PublicCollectionsSharedModule, SERVICES, dropLegacyCollectionKeywords, getPublicCollectionsState, getReducer, initialState };
+export type { CollectionDetailsItem, ICollectionDetailsLoadMore, ICollectionDetailsOptions, ICollectionRelatedArticle, ICollectionsCatalogLoadMore, ICollectionsCatalogOptions, ICollectionsCatalogSeo, IPublicCollectionPage, IPublicCollectionPaginator, State };