@softheon/armature 19.10.3 → 19.11.0

package/lib/base-components/sof-callout/sof-callout.component.d.ts

@@ -16,12 +16,26 @@ export declare class SofCalloutComponent {
      * @note Can be a translation key
     */
     text: string;
+    /**
+     * The callout text translation params object
+     * @optional
+    */
+    textParams?: {
+        [key: string]: string;
+    };
     /**
      * The callout extended message
      * @optional
      * @note Can be a translation key
     */
     extendedText?: string;
+    /**
+     * The callout extended message translation params object
+     * @optional
+    */
+    extendedTextParams?: {
+        [key: string]: string;
+    };
     /**
      * The text size
      * @optional
@@ -63,7 +77,7 @@ export declare class SofCalloutComponent {
     /** Emit event when action button is clicked */
     actionButtonClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SofCalloutComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SofCalloutComponent, "sof-callout", never, { "id": { "alias": "id"; "required": false; }; "type": { "alias": "type"; "required": true; }; "text": { "alias": "text"; "required": true; }; "extendedText": { "alias": "extendedText"; "required": false; }; "textSize": { "alias": "textSize"; "required": false; }; "iconOverrideClass": { "alias": "iconOverrideClass"; "required": false; }; "canDismiss": { "alias": "canDismiss"; "required": false; }; "actionButtonConfig": { "alias": "actionButtonConfig"; "required": false; }; }, { "actionButtonClicked": "actionButtonClicked"; "dismissEvent": "dismissEvent"; }, never, ["[callout-custom-content]"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SofCalloutComponent, "sof-callout", never, { "id": { "alias": "id"; "required": false; }; "type": { "alias": "type"; "required": true; }; "text": { "alias": "text"; "required": true; }; "textParams": { "alias": "textParams"; "required": false; }; "extendedText": { "alias": "extendedText"; "required": false; }; "extendedTextParams": { "alias": "extendedTextParams"; "required": false; }; "textSize": { "alias": "textSize"; "required": false; }; "iconOverrideClass": { "alias": "iconOverrideClass"; "required": false; }; "canDismiss": { "alias": "canDismiss"; "required": false; }; "actionButtonConfig": { "alias": "actionButtonConfig"; "required": false; }; }, { "actionButtonClicked": "actionButtonClicked"; "dismissEvent": "dismissEvent"; }, never, ["[callout-custom-content]"], true, never>;
 }
 export interface CalloutActionButtonConfig {
     id?: string;

package/lib/snackbar/snackbar.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @property `type!` 'success' | 'error' | 'info' | 'warning' | 'help'
+ * @property `message!` the message
+ * @property `messageParams?` the message translation key params {...params}
+ * @property `extendedMessage?` the extended message
+ * @property `extendedMessageParams?` the extended message translation key params {...params}
+ * @property `actionLabel?` label for the optional action button
+ * @note _all action buttons will be displayed as neutral mini buttons with no icon_
+ * @property `onAction?` method for the action button (disables auto-dismiss)
+ * @property `onDismiss?` method to call when dismissed
+ * @property `iconClassOverride?` icon class to override the default icon
+ * @example
+  const helpSnackbarSimple: SnackBar = {
+    type: "help",
+    message: "Important message"
+  };
+ * @example
+  const helpSnackbarFull: SnackBar = {
+    type: "help",
+    message: "important.message",
+    messageParams: {name: 'Armature'},
+    extendedMessage: "more.info",
+    extendedMessageParams: {ex: 'Example', id: id},
+    actionLabel: "Action",
+    onAction: () => this.takeAction(anyParams),
+    onDismiss: () => this.dismissEvent(anyParams),
+    iconClassOverride: "ph-bold ph-angular-logo"
+  };
+*/
+export interface Snackbar {
+    type: 'success' | 'error' | 'info' | 'warning' | 'help';
+    message: string;
+    messageParams?: {
+        [key: string]: string;
+    };
+    extendedMessage?: string;
+    extendedMessageParams?: {
+        [key: string]: string;
+    };
+    actionLabel?: string;
+    onAction?: () => void;
+    onDismiss?: () => void;
+    iconClassOverride?: string;
+}
+/**
+ * Snackbar interface ⚠️ FOR INTERNAL USE ONLY
+ * @note Adds the id & duration which are not configurable
+*/
+export interface _SnackbarInternal extends Snackbar {
+    id?: number;
+    duration?: number;
+}

package/lib/snackbar/snackbar.service.d.ts

@@ -0,0 +1,50 @@
+import { Signal } from '@angular/core';
+import { Snackbar, _SnackbarInternal } from './snackbar';
+import * as i0 from "@angular/core";
+/** Snackbar service */
+export declare class SnackbarService {
+    /** ( _private_ ) snackbar array signal */
+    private _snackbars;
+    /** ( _public readonly_ ) snackbar array signal */
+    readonly snackbars: Signal<Array<_SnackbarInternal>>;
+    /** ( _private readonly_ ) map snackbar dismiss duration based on type in milliseconds */
+    private readonly _durationMap;
+    /** ( _private_ ) saves all the snackbar duration timeouts to a Map */
+    private _timeouts;
+    /** ( _private_ ) internal use id to track the snackbars */
+    private _nextId;
+    /**
+     * ( _private_ ) set the snackbar timeout to the timeouts Map
+     * @param id snackbar id
+    */
+    private _setTimeout;
+    /**
+     * ( _private_ ) delete the snackbar timeout from the timeouts Map
+     * @param id snackbar id
+    */
+    private _deleteTimeout;
+    /**
+     * Show a snackbar
+     * @param snackbarInput the snackbar config
+     * @returns snackbar id, for testing
+    */
+    show(snackbarInput: Snackbar): number;
+    /**
+     * Dismiss a snackbar
+     * @param id the snackbar id to dismiss
+    */
+    dismiss(id: number): void;
+    /**
+     * Temporarily remove the snackbar timeout
+     * @param id snackbar id to pause dismissal timeout
+    */
+    pause(id: number): void;
+    /**
+     * Add back the snackbar timeout
+     * @param id snackbar id to resume dismissal timeout
+     * @param duration snackbar id to resume dismissal timeout
+    */
+    resume(id: number, duration: number): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SnackbarService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SnackbarService>;
+}

package/lib/snackbar/sof-snackbar/sof-snackbar.component.d.ts

@@ -0,0 +1,39 @@
+import { Signal } from '@angular/core';
+import { _SnackbarInternal } from '../snackbar';
+import * as i0 from "@angular/core";
+/** Snackbar component */
+export declare class SofSnackbarComponent {
+    /** Snackbar service */
+    private _snackbarService;
+    /** Snackbars array signal */
+    snackbars: Signal<Array<_SnackbarInternal>>;
+    /** Live announcer for screen reader wcag */
+    private _liveAnnouncerService;
+    /** Translation service */
+    private _translateService;
+    /**
+     * Dismiss a snackbar, calls onDismiss() if provided and not handleAction event
+     * @param snackbar the snackbar to dismiss
+     * @param skipCallback should we skip onDismiss if action button is clicked
+     * @note Screen reader will announce the dismissal
+    */
+    dismiss(snackbar: _SnackbarInternal, skipCallback?: boolean): void;
+    /**
+     * Pauses the snackbar dismiss duration on mouseenter
+     * @param id snackbar id to pause dismissal timeout
+    */
+    pause(id: number): void;
+    /**
+     * Resumes the snackbar dismiss duration on mouseleave
+     * @param id snackbar id to resume dismissal timeout
+     * @param duration snackbar id to resume dismissal timeout
+    */
+    resume(id: number, duration: number): void;
+    /**
+     * Call the onAction
+     * @param snackbar snackbar to act on
+    */
+    handleAction(snackbar: _SnackbarInternal): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SofSnackbarComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SofSnackbarComponent, "sof-snackbar", never, {}, {}, never, never, true, never>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softheon/armature",
-  "version": "19.10.3",
+  "version": "19.11.0",
   "dependencies": {
     "tslib": "^2.5.0"
   },

package/public-api.d.ts

@@ -47,6 +47,9 @@ export * from './lib/component-save-print/sof-ar-component-save-print.module';
 export * from './lib/component-save-print/components/component-save-print/component-save-print.component';
 export * from './lib/component-save-print/services/component-save-print.service';
 export * from './lib/rbac/services/tokens';
+export { Snackbar } from './lib/snackbar/snackbar';
+export * from './lib/snackbar/snackbar.service';
+export * from './lib/snackbar/sof-snackbar/sof-snackbar.component';
 export * from './lib/mfe/mfe.module';
 export * from './lib/mfe/services/entity-helper.service';
 export * from './lib/mfe/components/entity-base/entity-base.component';

package/ag-grid-components/package.json

@@ -1,3 +0,0 @@
-{
-  "module": "../fesm2022/softheon-armature-ag-grid-components.mjs"
-}