@sumaris-net/ngx-components 18.13.0 → 18.14.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sumaris-net/ngx-components",
   "description": "SUMARiS Angular components",
-  "version": "18.13.0",
+  "version": "18.14.1",
   "author": "contact@e-is.pro",
   "license": "AGPL-3.0",
   "readmeFilename": "README.md",

package/public_api.d.ts

@@ -282,6 +282,14 @@ export * from './src/app/social/message/message.model';
 export * from './src/app/social/message/message.service';
 export * from './src/app/social/message/message.form';
 export * from './src/app/social/message/message.modal';
+export * from './src/app/social/feed/feed.component';
+export * from './src/app/social/feed/feed.service';
+export * from './src/app/social/feed/feed.model';
+export * from './src/app/social/feed/feed.directive';
+export * from './src/app/social/feed/feed.module';
+export * from './src/app/social/feed/discourse/discourse-feed.service';
+export * from './src/app/social/feed/discourse/discourse.utils';
+export * from './src/app/social/feed/discourse/discourse.model';
 export * from './src/app/admin/admin.module';
 export { AdminRoutingModule } from './src/app/admin/admin-routing.module';
 export * from './src/app/admin/services/filter/person.filter';

package/src/app/core/home/home.d.ts

@@ -91,7 +91,7 @@ export declare class HomePage extends RxState<HomePageState> implements OnDestro
     get showInstallLinks(): boolean;
     set darkMode(value: boolean);
     get darkMode(): boolean;
-    get currentLocaleCode(): string;
+    get currentLocale(): string;
     get partnerBannerSize(): number;
     constructor(accountService: AccountService, modalCtrl: ModalController, translate: TranslateService, toastController: ToastController, configService: ConfigService, platform: PlatformService, cd: ChangeDetectorRef, network: NetworkService, settings: LocalSettingsService, environment: Environment, locales: LocaleConfig[], buttons: IMenuItem[], config: IHomePageConfig);
     ngOnDestroy(): void;

package/src/app/core/home/home.module.d.ts

@@ -8,8 +8,9 @@ import * as i6 from "../auth/auth.module";
 import * as i7 from "../install/install-upgrade-card.module";
 import * as i8 from "../../shared/markdown/markdown.module";
 import * as i9 from "../../social/user-event/user-event.module";
+import * as i10 from "../../social/feed/feed.module";
 export declare class AppHomePageModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<AppHomePageModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<AppHomePageModule, [typeof i1.HomePage], [typeof i2.SharedModule, typeof i3.RouterModule, typeof i4.TranslateModule, typeof i5.RxStateModule, typeof i6.AppAuthModule, typeof i7.AppInstallUpgradeCardModule, typeof i8.SharedMarkdownModule, typeof i9.UserEventModule], [typeof i3.RouterModule, typeof i4.TranslateModule, typeof i1.HomePage]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AppHomePageModule, [typeof i1.HomePage], [typeof i2.SharedModule, typeof i3.RouterModule, typeof i4.TranslateModule, typeof i5.RxStateModule, typeof i6.AppAuthModule, typeof i7.AppInstallUpgradeCardModule, typeof i8.SharedMarkdownModule, typeof i9.UserEventModule, typeof i10.FeedModule], [typeof i3.RouterModule, typeof i4.TranslateModule, typeof i1.HomePage]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<AppHomePageModule>;
 }

package/src/app/core/services/local-settings.service.d.ts

@@ -31,6 +31,7 @@ export declare class LocalSettingsService extends StartableService<LocalSettings
     private readonly defaultSettings;
     onChange: Subject<LocalSettings>;
     darkMode$: import("rxjs").Observable<boolean>;
+    locale$: import("rxjs").Observable<string>;
     private readonly _optionDefs;
     private readonly _serializeAsString;
     private _$persist;

package/src/app/core/services/network.service.d.ts

@@ -111,6 +111,7 @@ export declare class NetworkService extends StartableObservableService<Peer, Pee
     clearCache(opts?: {
         emitEvent?: boolean;
     }): Promise<void>;
+    fetch<T>(url: string): Promise<T>;
     protected ngOnStart(peer?: Peer): Promise<Peer>;
     protected ngOnAfterStart(peer: Peer): Promise<void>;
     protected ngOnStop(): void;

package/src/app/social/feed/discourse/discourse-feed.service.d.ts

@@ -0,0 +1,55 @@
+import DiscourseAPI from 'discourse2';
+import { JsonFeed } from '../feed.model';
+import { Observable } from 'rxjs';
+import { StartableService } from '../../../shared/services/startable-service.class';
+import { LocalSettingsService } from '../../../core/services/local-settings.service';
+import { Environment } from '../../../../environments/environment.class';
+import { LoadResult } from '../../../shared/services/entity-service.class';
+import { IFeedService } from '../feed.service';
+import * as i0 from "@angular/core";
+export interface DiscourseFeedServiceState {
+    locale: string;
+    feedUrls?: string[];
+}
+export declare class DiscourseFeedService extends StartableService<DiscourseFeedServiceState> implements IFeedService {
+    private settings;
+    protected environment: Environment;
+    private discourseApis;
+    private _logPrefix;
+    private _state;
+    private network;
+    locale$: Observable<string>;
+    feedUrls$: Observable<string[]>;
+    locale: string;
+    feedUrls: string[];
+    constructor(settings: LocalSettingsService, environment: Environment);
+    protected ngOnStart(): Promise<DiscourseFeedServiceState>;
+    watchAll(opts?: {
+        maxAgeInMonths?: number;
+        maxContentLength?: number;
+    }): Observable<LoadResult<JsonFeed>>;
+    getHomeUrl(feed?: JsonFeed): string;
+    getTagUrl(feed: JsonFeed, tag: string): string;
+    load(url: string, opts?: {
+        locale?: string;
+        maxAgeInMonths?: number;
+        maxContentLength?: number;
+        closeApis?: boolean;
+        depth?: number;
+    }): Promise<JsonFeed>;
+    loadAll(urls?: string[], opts?: {
+        locale?: string;
+        maxAgeInMonths?: number;
+        maxContentLength?: number;
+        closeApis?: boolean;
+        depth?: number;
+    }): Promise<LoadResult<JsonFeed>>;
+    protected getOrCreateDiscourseApi(url: string): DiscourseAPI;
+    protected closeApis(): void;
+    protected resolveFeedItems(json: JsonFeed, opts?: {
+        maxContentLength?: number;
+        depth?: number;
+    }): Promise<JsonFeed>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DiscourseFeedService, [null, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DiscourseFeedService>;
+}

package/src/app/social/feed/discourse/discourse.model.d.ts

@@ -0,0 +1,7 @@
+import type { operations } from 'discourse2/esm/schema';
+export type DiscourseCategory = operations['listCategoryTopics']['responses']['200']['content']['application/json'];
+export type DiscourseCategoryTopic = DiscourseCategory['topic_list']['topics'][0];
+export type DiscourseTopic = operations['getTopic']['responses']['200']['content']['application/json'];
+export type DiscoursePost = operations['getTopic']['responses']['200']['content']['application/json']['post_stream']['posts'][0] & {
+    post_url?: string;
+};

package/src/app/social/feed/discourse/discourse.utils.d.ts

@@ -0,0 +1,44 @@
+import DiscourseAPI from 'discourse2';
+import { JsonFeed, JsonFeedItem, JsonFeedUtils } from '../feed.model';
+import { DiscourseCategory, DiscoursePost, DiscourseTopic } from './discourse.model';
+export declare abstract class DiscourseUtils {
+    static _logPrefix: string;
+    static removeJsonExtension: typeof JsonFeedUtils.removeJsonExtension;
+    static isDiscourseObject(json: any): json is DiscourseTopic | DiscourseCategory;
+    static isDiscourseTopic(json: any | Partial<DiscourseTopic>): json is DiscourseTopic;
+    static isDiscourseCategory(json: any | Partial<DiscourseCategory>): json is DiscourseCategory;
+    static getDiscourseBaseUrl(url: string): string;
+    static isDiscourseCategoryUrl(url: string): RegExpMatchArray;
+    static extractCategoryIdFromUrl(url: string): number;
+    static extractCategorySlugFromUrl(url: string): string;
+    static extractTopicIdFromUrl(url: string): number;
+    static getLanguageFromTitle(title: string): string;
+    static getFeedsByUrl(url: string, opts?: {
+        api?: DiscourseAPI;
+        locale?: string;
+        maxAgeInMonths?: number;
+        maxContentLength?: number;
+    }): Promise<JsonFeed[]>;
+    static getFeedsByCategoryUrl(url: string, opts?: {
+        api?: DiscourseAPI;
+        locale?: string;
+        maxAgeInMonths?: number;
+        maxContentLength?: number;
+    }): Promise<JsonFeed[]>;
+    static getFeedByTopicUrl(url: string, opts?: {
+        locale?: string;
+        maxAgeInMonths?: number;
+        maxContentLength?: number;
+        api?: DiscourseAPI;
+    }): Promise<JsonFeed>;
+    static filterRecentPosts(posts: DiscoursePost[], opts?: {
+        maxAgeInMonths?: number;
+    }): DiscoursePost[];
+    static toFeed(posts: DiscoursePost[], topic: DiscourseTopic, url: string, opts?: {
+        maxContentLength?: number;
+    }): JsonFeed;
+    static toFeedItem(post: DiscoursePost, topic: DiscourseTopic, url: string, opts?: {
+        maxContentLength?: number;
+    }): JsonFeedItem;
+    static cleanTitle(title: string): string;
+}

package/src/app/social/feed/feed.component.d.ts

@@ -0,0 +1,39 @@
+import { RxState } from '@rx-angular/state';
+import { TranslateService } from '@ngx-translate/core';
+import { Router } from '@angular/router';
+import { JsonFeed } from './feed.model';
+import { Observable } from 'rxjs';
+import { PlatformService } from '../../core/services/platform.service';
+import { Environment } from '../../../environments/environment.class';
+import { AppColors } from '../../shared/types';
+import { IFeedService } from './feed.service';
+import * as i0 from "@angular/core";
+export interface FeedState {
+    maxAgeInMonths: number;
+    maxContentLength: number;
+    feeds: JsonFeed[];
+    hasFeeds: boolean;
+}
+export declare class FeedsComponent<T extends JsonFeed = JsonFeed> {
+    protected environment: Environment;
+    feedService: IFeedService<T>;
+    protected _debug: boolean;
+    protected _state: RxState<FeedState>;
+    protected translate: TranslateService;
+    protected platform: PlatformService;
+    protected router: Router;
+    protected version: string;
+    feeds$: Observable<T[]>;
+    hasFeeds$: Observable<boolean>;
+    feeds: T[];
+    hasFeeds: boolean;
+    showHeader: boolean;
+    headerTextColor: AppColors;
+    constructor(environment: Environment, feedService: IFeedService<T>);
+    openFeedHome(feed?: T): Promise<void>;
+    openUrl(url: string): Promise<void>;
+    openTag(feed: T, tag: string): Promise<void>;
+    getTags(feedOrItem?: T | T['items'][0]): string[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<FeedsComponent<any>, [null, { optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FeedsComponent<any>, "app-feeds", never, { "feeds": { "alias": "feeds"; "required": false; }; "showHeader": { "alias": "showHeader"; "required": false; }; "headerTextColor": { "alias": "headerTextColor"; "required": false; }; }, {}, never, never, false, never>;
+}

package/src/app/social/feed/feed.directive.d.ts

@@ -0,0 +1,32 @@
+import { AfterViewInit, ElementRef, OnDestroy } from '@angular/core';
+import { Subscription } from 'rxjs';
+import { UrlTree } from '@angular/router';
+import * as i0 from "@angular/core";
+export declare class FeedDirective implements AfterViewInit, OnDestroy {
+    private element;
+    private _subscription;
+    private platform;
+    private locationStrategy;
+    private navController;
+    private router;
+    private route;
+    private _feedUrl;
+    private _baseUrl;
+    set feedUrl(value: string);
+    get feedUrl(): string;
+    constructor(element: ElementRef<HTMLElement>);
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    protected listenClickEvents(nativeElement: HTMLElement): Subscription;
+    protected click(event: Event, containerElement: HTMLElement): Promise<boolean>;
+    scrollToAnchor(containerElement: HTMLElement, anchorId: string): void;
+    /**
+     * Transform a relative URL to its absolute representation according to current router state.
+     * @param url Relative URL path.
+     * @return Absolute URL based on the current route.
+     */
+    normalizeUrl(url: string): string;
+    getUrlTree(url: string): UrlTree;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FeedDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<FeedDirective, "feed,[feed]", never, { "feedUrl": { "alias": "feed"; "required": false; }; }, {}, never, never, false, never>;
+}

package/src/app/social/feed/feed.model.d.ts

@@ -0,0 +1,69 @@
+export interface JsonFeed {
+    version: string;
+    title: string;
+    home_page_url?: string;
+    feed_url?: string;
+    description?: string;
+    user_comment?: string;
+    next_url?: string;
+    icon?: string;
+    favicon?: string;
+    authors: JsonFeedAuthor[];
+    language?: string;
+    expired?: boolean;
+    items: JsonFeedItem[];
+    hubs?: {
+        type?: string;
+        url: string;
+    }[];
+    tag_template?: string;
+    /**
+     * @deprecated since version 1.1
+     */
+    author: JsonFeedAuthor;
+}
+export interface JsonFeedItem {
+    id: string;
+    url?: string;
+    external_url?: string;
+    title?: string;
+    content_html?: string;
+    content_text?: string;
+    summary?: string;
+    banner_image?: string;
+    date_published?: string;
+    date_modified?: string;
+    authors: JsonFeedAuthor[];
+    tags: string[];
+    language: string;
+    /**
+     * @deprecated since version 1.1
+     */
+    author: JsonFeedAuthor;
+    truncated: boolean;
+}
+export interface JsonFeedAuthor {
+    name?: string;
+    url?: string;
+    avatar?: string;
+}
+export declare class JsonFeedUtils {
+    static DEFAULT_MAX_POST_AGE_IN_MONTHS: number;
+    static VERSION_1: string;
+    static VERSION_1_1: string;
+    static ACCEPTED_VERSIONS: string[];
+    static removeJsonExtension(url: string): string;
+    static isJsonFeed(json: any): json is JsonFeed;
+    static isJsonFeedItem(json: any): json is JsonFeedItem;
+    static truncateFeedItemsHtml(feed: JsonFeed, opts?: {
+        maxContentLength?: number;
+    }): JsonFeed;
+    static truncateHtml(html: string, opts?: {
+        maxContentLength?: number;
+    }): string;
+    /**
+     * Migrate from old version 1.0 to 1.1
+     * @param feed
+     */
+    static migrateFeed(feed: JsonFeed): JsonFeed;
+}

package/src/app/social/feed/feed.module.d.ts

@@ -0,0 +1,11 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./feed.component";
+import * as i2 from "./feed.directive";
+import * as i3 from "../../shared/shared.module";
+import * as i4 from "@ngx-translate/core";
+import * as i5 from "@angular/common";
+export declare class FeedModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<FeedModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<FeedModule, [typeof i1.FeedsComponent, typeof i2.FeedDirective], [typeof i3.SharedModule, typeof i4.TranslateModule, typeof i5.NgOptimizedImage], [typeof i4.TranslateModule, typeof i1.FeedsComponent, typeof i2.FeedDirective]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<FeedModule>;
+}

package/src/app/social/feed/feed.service.d.ts

@@ -0,0 +1,13 @@
+import { Observable } from 'rxjs';
+import { LoadResult } from '../../shared/services/entity-service.class';
+import { JsonFeed } from './feed.model';
+import { InjectionToken } from '@angular/core';
+export declare const APP_FEED_SERVICE: InjectionToken<IFeedService<any>>;
+export interface IFeedService<T extends JsonFeed = JsonFeed> {
+    watchAll(opts?: {
+        maxAgeInMonths?: number;
+        maxContentLength?: number;
+    }): Observable<LoadResult<T>>;
+    getHomeUrl(feed?: T): string;
+    getTagUrl(feed: T, tag: string): string;
+}

package/src/assets/i18n/en-US.json

@@ -551,7 +551,7 @@
     },
     "MESSAGE": {
       "TYPE": "Message type",
-      "RECIPIENTS": "Recipients",²
+      "RECIPIENTS": "Recipients",
       "RECIPIENT_FILTER_COUNT": "{{count}} filtered users",
       "SUBJECT": "Object",
       "BODY_HELP": "Your message...",
@@ -564,6 +564,10 @@
         "FEED": "Feed"
       }
     },
+    "FEED": {
+      "NEWS": "News",
+      "SHOW_ALL_FEED": "Show all"
+    },
     "ERROR": {
       "LOAD_USER_EVENTS_ERROR": "Error while loading notifications",
       "COUNT_USER_EVENT_ERROR": "Error while counting notifications",

package/src/assets/i18n/en.json

@@ -564,6 +564,11 @@
         "FEED": "Feed"
       }
     },
+    "FEED": {
+      "NEWS": "News",
+      "READ_MORE": "Read more",
+      "SHOW_ALL_FEED": "Show all"
+    },
     "ERROR": {
       "LOAD_USER_EVENTS_ERROR": "Error while loading notifications",
       "COUNT_USER_EVENT_ERROR": "Error while counting notifications",

package/src/assets/i18n/fr.json

@@ -564,6 +564,11 @@
         "FEED": "Actualité"
       }
     },
+    "FEED": {
+      "NEWS": "Actualités",
+      "READ_MORE": "Lire la suite",
+      "SHOW_ALL_FEED": "Voir tout"
+    },
     "ERROR": {
       "LOAD_USER_EVENTS_ERROR": "Erreur de chargement des notifications",
       "COUNT_USER_EVENT_ERROR": "Erreur de comptage des notifications",

package/src/environments/environment.class.d.ts

@@ -72,4 +72,12 @@ export declare class Environment {
         enableListenChanges?: boolean;
         listenIntervalInSeconds?: number;
     };
+    feed?: {
+        jsonFeed: {
+            [key: string]: string[];
+        };
+        maxContentLength: number;
+        maxAgeInMonths: number;
+        maxCount: number;
+    };
 }