@progressive-development/pd-spa-helper 0.9.0 → 0.9.1

package/dist/components/pd-spa-helper/PdSpaHelper.d.ts

@@ -0,0 +1,160 @@
+import { LitElement, CSSResultGroup, TemplateResult, PropertyValues } from 'lit';
+import { ButtonData } from '@progressive-development/pd-forms';
+import { AppConfiguration, Footer, NavigationPage } from '../../service-provider/service-provider-model.js';
+import { LoadingState } from '@progressive-development/pd-content';
+import { ScrollController } from './controllers/ScrollController.js';
+/**
+ * Initialize the SPA framework.
+ *
+ * This function must be called before using PdSpaHelper components.
+ * It sets up:
+ * - Service provider (Firebase or Mock)
+ * - Redux store
+ * - Router with configured routes
+ *
+ * @param config - The application configuration
+ *
+ * @example
+ * ```typescript
+ * startInit({
+ *   serviceProvider: "firebase",
+ *   firebaseConfig: { ... },
+ *   navigationConfigParam: {
+ *     pages: [...],
+ *     includeLogin: true,
+ *   },
+ *   storeConfigParam: {
+ *     appName: "My App",
+ *     reducer: [...],
+ *     effects: [...],
+ *   },
+ * });
+ * ```
+ */
+export declare const startInit: (config: AppConfiguration) => void;
+/**
+ * Abstract base class for SPA applications.
+ *
+ * Extend this class to create your main application component.
+ * Override the abstract methods to customize the layout and content.
+ *
+ * Required abstract methods:
+ * - `_renderRoutePages(route)` - Render content for given route
+ * - `_getFooter()` - Return footer configuration
+ * - `_getAppLogo()` - Return app logo template
+ * - `_setLocale()` - Handle locale changes
+ * - `_getAppConfiguration()` - Return app-specific config
+ */
+export declare abstract class PdSpaHelper extends LitElement {
+    /** Controller for scroll threshold detection (teaser collapse) */
+    protected scrollController: ScrollController;
+    title: string;
+    /** Scroll threshold in pixels for teaser collapse. Default: 100px */
+    teaserCollapseThreshold: number;
+    /** Current loading states */
+    protected _loadingState: LoadingState[];
+    /** Current route name */
+    protected _route: string;
+    /** Route parameters */
+    protected _params: Record<string, string>;
+    /** Query parameters */
+    protected _query: Record<string, string>;
+    /** Whether the teaser is collapsed (scrolled past threshold) */
+    protected teaserCollapsed: boolean;
+    /**
+     * Skip teaser transition during navigate-and-scroll.
+     * Prevents the "teaser appears then collapses" visual glitch.
+     */
+    private _skipTeaserTransition;
+    /** Pending section ID for navigate-and-scroll (stored until init-menu-sections fires) */
+    private _pendingScrollSectionId;
+    /** Currently selected locale - must be implemented by subclass */
+    abstract _selectedLocale: string;
+    private _claims;
+    /** Available locales with display text and value - must be implemented by subclass */
+    abstract _availableLocales: ButtonData[];
+    /** Whether to show locale selector in single menu only */
+    protected _singleLocaleMenu: boolean;
+    /** Store subscription for cleanup */
+    private _subscription?;
+    /** Track previous auth state to detect real transitions (not initial load) */
+    private _previousAuthState;
+    /** Map of section IDs to action creator functions */
+    private _sectionActions;
+    static styles: CSSResultGroup;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected willUpdate(changedProps: PropertyValues): void;
+    render(): TemplateResult;
+    /**
+     * Render the loading state while route is being resolved
+     * Can be overridden by subclass
+     */
+    protected _renderLoading(): TemplateResult;
+    /**
+     * Render the main layout
+     * Can be overridden by subclass for custom layouts
+     */
+    protected _renderLayout(pageConf: NavigationPage, showTeaser: boolean): TemplateResult;
+    /**
+     * Render the login modal popup
+     */
+    private _renderLoginModal;
+    /**
+     * Handle login popup close (user aborted login via Escape or backdrop click)
+     */
+    private _handleLoginPopupClose;
+    protected _renderMenu(pageConfig: NavigationPage, showTeaser: boolean): TemplateResult | string;
+    protected _renderTopMenu(pageConfig: NavigationPage, showTeaser: boolean): TemplateResult | string;
+    protected _renderTeaser(): TemplateResult | string;
+    protected _renderFooter(): TemplateResult;
+    /**
+     * Render the content for the given route
+     * @param route - The route to render (may differ from _route for modal scenarios)
+     */
+    protected abstract _renderRoutePages(route: string): TemplateResult;
+    /**
+     * Get the footer configuration
+     */
+    protected abstract _getFooter(): Footer;
+    /**
+     * Get the app logo template
+     */
+    protected abstract _getAppLogo(): TemplateResult;
+    /**
+     * Set the locale
+     */
+    protected abstract _setLocale(locale: string): void;
+    /**
+     * Get app-specific configuration
+     */
+    protected abstract _getAppConfiguration(): unknown;
+    /**
+     * Get teaser content panels
+     * Override to provide teaser content, or return empty array for no teaser
+     */
+    protected _getTeaserContent(): TemplateResult[];
+    private _handleRouteEvent;
+    private _handleFooterLink;
+    private _handleInitMenuSections;
+    /**
+     * Handle section-activated event from pd-menu.
+     * Dispatches the registered action for a section (once per session).
+     */
+    private _handleSectionActivated;
+    private _handleLocaleChange;
+    private _handleAppConfigEvent;
+    private _activateLoginHandler;
+    private _getMainClass;
+    private _navigateToPage;
+    /**
+     * Scroll to a section element. Collapses teaser if expanded.
+     */
+    private _scrollToSection;
+    /**
+     * Find section element by sectionId from current page's menu refs.
+     */
+    private _findSectionElement;
+}
+//# sourceMappingURL=PdSpaHelper.d.ts.map

package/dist/components/pd-spa-helper/PdSpaHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PdSpaHelper.d.ts","sourceRoot":"","sources":["../../../src/components/pd-spa-helper/PdSpaHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAEL,UAAU,EAEV,cAAc,EACd,cAAc,EACd,cAAc,EACf,MAAM,KAAK,CAAC;AAKb,OAAO,0CAA0C,CAAC;AAClD,OAAO,4CAA4C,CAAC;AACpD,OAAO,qDAAqD,CAAC;AAC7D,OAAO,8CAA8C,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAMpE,OAAO,EACL,gBAAgB,EAChB,MAAM,EAEN,cAAc,EACf,MAAM,kDAAkD,CAAC;AAG1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAaxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAIrE,OAAO,kCAAkC,CAAC;AAC1C,OAAO,yCAAyC,CAAC;AAGjD,OAAO,2CAA2C,CAAC;AACnD,OAAO,sDAAsD,CAAC;AAC9D,OAAO,6CAA6C,CAAC;AAarD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,gBAAgB,KAAG,IASpD,CAAC;AAQF;;;;;;;;;;;;GAYG;AACH,8BAAsB,WAAY,SAAQ,UAAU;IAKlD,kEAAkE;IAClE,SAAS,CAAC,gBAAgB,mBAQvB;IAOH,KAAK,SAAY;IAEjB,qEAAqE;IAErE,uBAAuB,SAAqB;IAM5C,6BAA6B;IAE7B,SAAS,CAAC,aAAa,EAAE,YAAY,EAAE,CAAM;IAE7C,yBAAyB;IAEzB,SAAS,CAAC,MAAM,SAAM;IAEtB,uBAAuB;IAEvB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAE/C,uBAAuB;IAEvB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAE9C,gEAAgE;IAEhE,SAAS,CAAC,eAAe,UAAS;IAElC;;;OAGG;IAMH,OAAO,CAAC,qBAAqB,CAAS;IAEtC,yFAAyF;IACzF,OAAO,CAAC,uBAAuB,CAAuB;IAEtD,kEAAkE;IAElE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAGjC,OAAO,CAAC,OAAO,CAAW;IAE1B,sFAAsF;IACtF,QAAQ,CAAC,iBAAiB,EAAE,UAAU,EAAE,CAAC;IAEzC,0DAA0D;IAC1D,SAAS,CAAC,iBAAiB,UAAS;IAEpC,qCAAqC;IACrC,OAAO,CAAC,aAAa,CAAC,CAAe;IAErC,8EAA8E;IAC9E,OAAO,CAAC,kBAAkB,CACd;IAMZ,qDAAqD;IAErD,OAAO,CAAC,eAAe,CAAgC;IAMvD,MAAM,CAAC,MAAM,EAiJR,cAAc,CAAC;;IA+BpB,iBAAiB,IAAI,IAAI;IA0CzB,oBAAoB,IAAI,IAAI;cAaT,UAAU,CAAC,YAAY,EAAE,cAAc,GAAG,IAAI;IA8CjE,MAAM,IAAI,cAAc;IAmBxB;;;OAGG;IACH,SAAS,CAAC,cAAc,IAAI,cAAc;IAI1C;;;OAGG;IACH,SAAS,CAAC,aAAa,CACrB,QAAQ,EAAE,cAAc,EACxB,UAAU,EAAE,OAAO,GAClB,cAAc;IAsCjB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAazB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAS9B,SAAS,CAAC,WAAW,CACnB,UAAU,EAAE,cAAc,EAC1B,UAAU,EAAE,OAAO,GAClB,cAAc,GAAG,MAAM;IAgC1B,SAAS,CAAC,cAAc,CACtB,UAAU,EAAE,cAAc,EAC1B,UAAU,EAAE,OAAO,GAClB,cAAc,GAAG,MAAM;IA0B1B,SAAS,CAAC,aAAa,IAAI,cAAc,GAAG,MAAM;IAalD,SAAS,CAAC,aAAa,IAAI,cAAc;IAkBzC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc;IAEnE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,IAAI,MAAM;IAEvC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,IAAI,cAAc;IAEhD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAEnD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,oBAAoB,IAAI,OAAO;IAMlD;;;OAGG;IACH,SAAS,CAAC,iBAAiB,IAAI,cAAc,EAAE;IAQ/C,OAAO,CAAC,iBAAiB;IAgBzB,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,uBAAuB;IA+C/B;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,mBAAmB;IAQ3B,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,qBAAqB;IA0D7B,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,eAAe;IAKvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;OAEG;IACH,OAAO,CAAC,mBAAmB;CAa5B"}