@forgeroute/ui 0.4.40 → 0.4.42

package/types/forgeroute-ui.d.ts

@@ -1,8 +1,8 @@
 import * as i0 from "@angular/core";
 import { EnvironmentProviders, InjectionToken, OnDestroy, OnInit, Signal, TemplateRef, WritableSignal } from "@angular/core";
 import { UrlTree } from "@angular/router";
-import { AbstractControl, ControlValueAccessor, FormControl, ValidationErrors, Validator } from "@angular/forms";
 import { Observable } from "rxjs";
+import { AbstractControl, ControlValueAccessor, FormControl, ValidationErrors, Validator } from "@angular/forms";
 import { HttpInterceptorFn } from "@angular/common/http";
 import { SafeHtml } from "@angular/platform-browser";
 export interface ForgerouteConfig {
@@ -1088,7 +1088,7 @@ export declare class SelectComponent implements ControlValueAccessor, Validator,
   readonly error: import("@angular/core").InputSignal<string>;
   /** Reveal the built-in error messages now (e.g. after a failed Save click), without waiting for blur. */
   readonly showErrors: import("@angular/core").InputSignal<boolean>;
-  readonly size: import("@angular/core").InputSignal<"default" | "sm">;
+  readonly size: import("@angular/core").InputSignal<"sm" | "default">;
   readonly _disabledInput: import("@angular/core").InputSignal<boolean>;
   private readonly _cvaDisabled;
   protected readonly disabled: import("@angular/core").Signal<boolean>;
@@ -1222,6 +1222,8 @@ export interface ImportExportConfig {
   importFields?: ImportFieldDef[];
   columnAliases?: Record<string, string[]>;
   templateSampleRows?: string[][];
+  /** Text of the template download button inside the import window, e.g. "Download Cases CSV Template" (default: "Download template"). */
+  templateLabel?: string;
   /** When true, the Export button appears in the More Actions dropdown instead of as a standalone button. */
   exportInMoreActions?: boolean;
 }
@@ -1229,12 +1231,37 @@ interface ImportError {
   row: number;
   message: string;
 }
+export interface ImportSubmitRequest {
+  file: File | null;
+  records: Record<string, string>[];
+  mapping: Record<string, string>;
+}
+export interface ImportSubmitResult {
+  imported: number;
+  errors?: {
+    row: number;
+    message: string;
+  }[];
+  warnings?: {
+    row: number;
+    message: string;
+  }[];
+}
 type ImportStep = 'source' | 'upload' | 'mapping' | 'preview' | 'result';
 export declare class ImportExportComponent {
   readonly _configInput: import("@angular/core").InputSignal<ImportExportConfig | null>;
   readonly importSources: import("@angular/core").InputSignal<ImportSource[] | undefined>;
   readonly exportParams: import("@angular/core").InputSignal<Record<string, string>>;
   readonly exportOnly: import("@angular/core").InputSignal<boolean>;
+  /** The window's footer has one Close button that closes it at once, never Back / Cancel (the setup wizard). */
+  readonly closeOnly: import("@angular/core").InputSignal<boolean>;
+  /**
+   * Replaces the built-in `POST importEndpoint { records }` for an app whose import runs differently (e.g. the server reads the CSV file itself):
+   * receives the chosen file, the parsed rows (field key -> value) and the mapping (field key -> CSV column) and answers the result.
+   */
+  readonly submit: import("@angular/core").InputSignal<((request: ImportSubmitRequest) => Observable<ImportSubmitResult>) | null>;
+  /** Fired when the user presses Done after an import, with what the import answered (also `imported`). */
+  readonly finished: import("@angular/core").OutputEmitterRef<ImportSubmitResult>;
   readonly imported: import("@angular/core").OutputEmitterRef<void>;
   config: ImportExportConfig;
   private readonly http;
@@ -1273,6 +1300,7 @@ export declare class ImportExportComponent {
   closeImport(): void;
   finishImport(): void;
   onFileChange(event: Event): void;
+  private csvFile;
   private readCsvFile;
   private autoMap;
   get canSubmit(): boolean;
@@ -1308,7 +1336,18 @@ export declare class ImportExportComponent {
       "required": false;
       "isSignal": true;
     };
+    "closeOnly": {
+      "alias": "closeOnly";
+      "required": false;
+      "isSignal": true;
+    };
+    "submit": {
+      "alias": "submit";
+      "required": false;
+      "isSignal": true;
+    };
   }, {
+    "finished": "finished";
     "imported": "imported";
   }, never, never, true, never>;
 }
@@ -2167,7 +2206,7 @@ export declare class ModalComponent implements OnInit, OnDestroy {
   readonly title: import("@angular/core").InputSignal<string>;
   readonly description: import("@angular/core").InputSignal<string>;
   readonly maxWidth: import("@angular/core").InputSignal<string>;
-  readonly bodyOverflow: import("@angular/core").InputSignal<"hidden" | "auto" | "visible">;
+  readonly bodyOverflow: import("@angular/core").InputSignal<"hidden" | "visible" | "auto">;
   /** `data-testid` of the dialog element itself (the host `<ui-modal>` is always in the page, the dialog only while open). None when empty. */
   readonly dialogTestId: import("@angular/core").InputSignal<string>;
   /** Hides the header X button (e.g. while a request is running). Escape and a backdrop click still close unless `closable` is false. */
@@ -2551,7 +2590,7 @@ export declare class AudioPlayerComponent {
   /** Accessible name of the player. */
   readonly ariaLabel: import("@angular/core").InputSignal<string>;
   /** How much to load before play: 'metadata' (default), 'auto' or 'none'. */
-  readonly preload: import("@angular/core").InputSignal<"none" | "auto" | "metadata">;
+  readonly preload: import("@angular/core").InputSignal<"none" | "metadata" | "auto">;
   /** Fires when the browser can't load or decode the source. */
   readonly playbackError: import("@angular/core").OutputEmitterRef<void>;
   protected readonly failed: import("@angular/core").WritableSignal<boolean>;
@@ -2805,7 +2844,7 @@ export declare class CheckboxComponent implements ControlValueAccessor, Validato
    * clicking it still toggles the box - e.g. a product name that is both the heading of its card and the label of its checkbox.
    * Default null: plain label text, exactly as before. Single mode only.
    */
-  readonly headingLevel: import("@angular/core").InputSignal<1 | 2 | 3 | 4 | 5 | 6 | null>;
+  readonly headingLevel: import("@angular/core").InputSignal<2 | 1 | 5 | 3 | 4 | 6 | null>;
   readonly indeterminate: import("@angular/core").InputSignal<boolean>;
   readonly checked: import("@angular/core").ModelSignal<boolean>;
   /**
@@ -3716,7 +3755,7 @@ export declare class PhoneNumberPickerComponent {
   protected readonly modeCtl: FormControl<string>;
   protected readonly zipCtl: FormControl<string>;
   protected readonly areaCtl: FormControl<string>;
-  protected readonly step: import("@angular/core").WritableSignal<1 | 2 | 3>;
+  protected readonly step: import("@angular/core").WritableSignal<2 | 1 | 3>;
   protected readonly mode: import("@angular/core").WritableSignal<PhoneNumberSearchMode>;
   private readonly _zip;
   private readonly _area;
@@ -3830,7 +3869,7 @@ export declare class ButtonComponent {
    * `ghost-start`: a ghost button for list / section toggles - a full-width row with its content aligned to the start, transparent
    * background, hover tint and the normal focus ring. Pair it with `ariaExpanded` / `ariaPressed`; the label may contain a heading element.
    */
-  readonly variant: import("@angular/core").InputSignal<"primary" | "secondary" | "danger" | "warning" | "link" | "ghost" | "ghost-start" | "tab" | "icon" | "icon-danger">;
+  readonly variant: import("@angular/core").InputSignal<"link" | "primary" | "secondary" | "danger" | "warning" | "ghost" | "ghost-start" | "tab" | "icon" | "icon-danger">;
   /** Renders an anchor to this route instead of a button (use with `variant="link"` for an inline text link). `['/settings']` or `'/settings'`. While `disabled` or `loading` it renders a non-clickable `<span role="link" aria-disabled>` with no href (like `href`). */
   readonly routerLink: import("@angular/core").InputSignal<string | readonly unknown[] | null>;
   /** Query params of the `routerLink` (e.g. `{ section: 'deal-defaults' }`). */
@@ -3851,7 +3890,7 @@ export declare class ButtonComponent {
    */
   readonly href: import("@angular/core").InputSignal<string | null>;
   /** Where to open the `href` (`_blank` = a new tab). */
-  readonly target: import("@angular/core").InputSignal<"_self" | "_blank" | "_parent" | "_top" | null>;
+  readonly target: import("@angular/core").InputSignal<"_blank" | "_self" | "_parent" | "_top" | null>;
   /** `rel` of the `href` link. A `_blank` target always gets `noopener noreferrer` added. */
   readonly rel: import("@angular/core").InputSignal<string | null>;
   /** The href when it is allowed (http, https, mailto, tel, sms or a relative URL), else null. */
@@ -3876,7 +3915,7 @@ export declare class ButtonComponent {
   readonly color: import("@angular/core").InputSignal<string | undefined>;
   readonly active: import("@angular/core").InputSignal<boolean>;
   readonly size: import("@angular/core").InputSignal<"sm" | "md" | "lg" | "xs">;
-  readonly type: import("@angular/core").InputSignal<"reset" | "submit" | "button">;
+  readonly type: import("@angular/core").InputSignal<"button" | "reset" | "submit">;
   readonly disabled: import("@angular/core").InputSignal<boolean>;
   readonly loading: import("@angular/core").InputSignal<boolean>;
   readonly fullWidth: import("@angular/core").InputSignal<boolean>;
@@ -4363,7 +4402,7 @@ export declare class ImportSourceGridComponent {
   /** The `value` of the picked source (highlighted). `tile` only: the `card` appearance does not keep a selection. */
   readonly selected: import("@angular/core").InputSignal<string>;
   /** `tile`: the compact buttons of the import window. `card`: one `ui-detail-card` per source with its own select button (used on a page). */
-  readonly appearance: import("@angular/core").InputSignal<"card" | "tile">;
+  readonly appearance: import("@angular/core").InputSignal<"tile" | "card">;
   /** `card`: disables every card's button (for example while the page is saving). */
   readonly disabled: import("@angular/core").InputSignal<boolean>;
   /** `card`: the text of each card's button. */
@@ -4672,7 +4711,7 @@ export declare class TextInputComponent implements ControlValueAccessor, Validat
   readonly passwordRequirements: import("@angular/core").InputSignal<boolean>;
   /** Rules for `passwordRequirements`; default = the library's five rules (8+ characters, upper, lower, digit, special). */
   readonly passwordRules: import("@angular/core").InputSignal<readonly PasswordRule[] | undefined>;
-  readonly type: import("@angular/core").InputSignal<"number" | "text" | "email" | "tel" | "password" | "url">;
+  readonly type: import("@angular/core").InputSignal<"number" | "text" | "email" | "password" | "tel" | "url">;
   readonly maxlength: import("@angular/core").InputSignal<number | undefined>;
   readonly required: import("@angular/core").InputSignal<boolean>;
   readonly autocomplete: import("@angular/core").InputSignal<string>;
@@ -4745,7 +4784,7 @@ export declare class TextInputComponent implements ControlValueAccessor, Validat
   protected readonly _stepAttr: import("@angular/core").Signal<string | null>;
   protected readonly _revealable: import("@angular/core").Signal<boolean>;
   protected readonly _shown: import("@angular/core").WritableSignal<boolean>;
-  protected readonly _inputType: import("@angular/core").Signal<"number" | "text" | "email" | "tel" | "password" | "url">;
+  protected readonly _inputType: import("@angular/core").Signal<"number" | "text" | "email" | "password" | "tel" | "url">;
   protected readonly _eyePath: string;
   protected readonly _eyeOffPath: string;
   protected readonly _showRequirements: import("@angular/core").Signal<boolean>;
@@ -6296,7 +6335,7 @@ export declare class FormSectionComponent {
   }, {}, never, ["*"], true, never>;
 }
 export declare class FormRowComponent {
-  readonly cols: import("@angular/core").InputSignal<1 | 2 | 3 | 4>;
+  readonly cols: import("@angular/core").InputSignal<2 | 1 | 3 | 4>;
   static ɵfac: i0.ɵɵFactoryDeclaration<FormRowComponent, never>;
   static ɵcmp: i0.ɵɵComponentDeclaration<FormRowComponent, "ui-form-row", never, {
     "cols": {
@@ -6313,7 +6352,7 @@ export declare class FormRowComponent {
  * child simply takes the full width. Keep a numeric span within the row's `cols` (use `all` for the whole row).
  */
 export declare class FormColSpanDirective {
-  readonly uiColSpan: import("@angular/core").InputSignal<"" | "2" | "3" | 2 | 3 | "all">;
+  readonly uiColSpan: import("@angular/core").InputSignal<"" | 2 | "2" | "3" | 3 | "all">;
   protected readonly _class: import("@angular/core").Signal<string>;
   static ɵfac: i0.ɵɵFactoryDeclaration<FormColSpanDirective, never>;
   static ɵdir: i0.ɵɵDirectiveDeclaration<FormColSpanDirective, "[uiColSpan]", never, {
@@ -7599,6 +7638,8 @@ export declare class AlertComponent {
    * Default false: the body is a flex row with a gap, exactly as before (use it for text plus a button).
    */
   readonly inline: import("@angular/core").InputSignal<boolean>;
+  /** The box fills the height of its parent cell (two alerts in one grid row get the same height whatever their text length). Default false. */
+  readonly fill: import("@angular/core").InputSignal<boolean>;
   readonly dismissed: import("@angular/core").OutputEmitterRef<void>;
   static ɵfac: i0.ɵɵFactoryDeclaration<AlertComponent, never>;
   static ɵcmp: i0.ɵɵComponentDeclaration<AlertComponent, "ui-alert", never, {
@@ -7637,6 +7678,11 @@ export declare class AlertComponent {
       "required": false;
       "isSignal": true;
     };
+    "fill": {
+      "alias": "fill";
+      "required": false;
+      "isSignal": true;
+    };
   }, {
     "dismissed": "dismissed";
   }, never, ["*"], true, never>;
@@ -9247,7 +9293,7 @@ export declare class DetailCardComponent {
   /** true (default) = the title is displayed in capitals (CSS only); false = shown as written. The text, aria-label and heading name are never changed. */
   readonly uppercaseTitle: import("@angular/core").InputSignal<boolean>;
   /** 1-6 makes the title a real heading for screen readers (role=heading, aria-level); null keeps it plain text. */
-  readonly headingLevel: import("@angular/core").InputSignal<1 | 2 | 3 | 4 | 5 | 6 | null>;
+  readonly headingLevel: import("@angular/core").InputSignal<2 | 1 | 5 | 3 | 4 | 6 | null>;
   /** Optional id for the title text; the card is then labelled by it. Without it the title is the card's aria-label. */
   readonly titleId: import("@angular/core").InputSignal<string>;
   /** Accessible name of the card when the header gives none (no header, or no title). A visible title wins; blank = no name. */
@@ -9466,6 +9512,55 @@ export declare class DividerComponent {
     };
   }, {}, never, never, true, never>;
 }
+export type FixedFooterAlign = 'start' | 'center' | 'end' | 'between';
+/**
+ * A footer bar fixed to the bottom of the page: it stays visible while the page scrolls, sits flush with the bottom of the viewport
+ * and spans the full width of the content area (from the side nav to the end of the screen). Put it as the LAST child of the page:
+ *
+ *   <div class="settings-page">
+ *     ...the page content...
+ *     <ui-fixed-footer>
+ *       <ui-button variant="primary" (click)="save()">Save All Settings</ui-button>
+ *     </ui-fixed-footer>
+ *   </div>
+ *
+ * How it works: the bar is `position: sticky` at the bottom of the scrolling page. Inside `ui-app-shell` the content area is padded
+ * (24px / 16px / 12px by width) and the shell publishes that padding as `--shell-content-padding`; the footer cancels it with negative
+ * margins and a negative `bottom`, so it reaches the viewport edges instead of stopping inside the padding. Outside the shell the
+ * variable is unset (0px) and the bar simply sticks to the bottom of its scrolling parent. Nothing else needs to be set up.
+ *
+ * Inputs:
+ *  - `align` (default `end`): where the projected content sits: start | center | end | between.
+ *  - `ariaLabel` (default `Page actions`): the accessible name of the bar (a labelled region).
+ *  - `elevated` (default true): the soft shadow above the bar; false = just the top border.
+ * Theming by CSS custom properties: `--ui-footer-bg` (white), `--ui-footer-border` (#e2e8f0), `--ui-footer-pad-y` (20px; 16px up to 1024px, 14px up to 480px).
+ */
+export declare class FixedFooterComponent {
+  /** Where the projected content sits in the bar. */
+  readonly align: import("@angular/core").InputSignal<FixedFooterAlign>;
+  /** Accessible name of the bar. */
+  readonly ariaLabel: import("@angular/core").InputSignal<string>;
+  /** The soft shadow above the bar (false = only the top border). */
+  readonly elevated: import("@angular/core").InputSignal<boolean>;
+  static ɵfac: i0.ɵɵFactoryDeclaration<FixedFooterComponent, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<FixedFooterComponent, "ui-fixed-footer", never, {
+    "align": {
+      "alias": "align";
+      "required": false;
+      "isSignal": true;
+    };
+    "ariaLabel": {
+      "alias": "ariaLabel";
+      "required": false;
+      "isSignal": true;
+    };
+    "elevated": {
+      "alias": "elevated";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {}, never, ["*"], true, never>;
+}
 /** One column (stage) of a [ui-board]. `items` are the host's own records; the board never reads their fields. */
 export interface BoardColumn<T = unknown> {
   /** Unique id of the column (the stage key); reported in `from` / `to` of a move. */
@@ -11313,12 +11408,13 @@ export interface IntegrationPlainText {
 export declare function integrationPlainText(html: string): IntegrationPlainText;
 /**
  * How a connect button for an integration works.
- *  - `oauth`: GET `authorizeEndpoint` answers `{ url }` (or `{ authUrl }`) and the browser goes there (QuickBooks, Slack, Gmail, Outlook, Google / Outlook calendar, Stripe, Square).
+ *  - `oauth`: GET `authorizeEndpoint` answers `{ url }` (or `{ authUrl }`) and the browser goes there (in a NEW tab with `newTab: true`, opened inside the click so popup blockers allow it, else in this tab) (QuickBooks, Slack, Gmail, Outlook, Google / Outlook calendar, Stripe, Square).
  *  - `area-code`: asks for a US area code and POSTs `{ areaCode }` to `connectEndpoint` (Twilio buys a number that way); the status is reloaded after.
  */
 export type SetupIntegrationConnect = {
   type: 'oauth';
   authorizeEndpoint: string;
+  newTab?: boolean;
 } | {
   type: 'area-code';
   connectEndpoint: string;
@@ -11394,6 +11490,8 @@ export interface SetupImportStep {
   buttonLabel: string;
   /** Hint above the button. */
   hint?: string;
+  /** Runs the import instead of `config.importEndpoint` (see `ImportExportComponent.submit`), e.g. when the server reads the CSV file itself. */
+  submit?: (request: ImportSubmitRequest) => Observable<ImportSubmitResult>;
   /** Result alert title, built from the number imported (default `${n} ${config.entityNamePlural.toLowerCase()} imported successfully.`). */
   resultTitle?: (imported: number) => string;
   /** Result alert body. */
@@ -11550,7 +11648,7 @@ export declare class SetupWizardComponent {
   /** An import step with `requireImport` keeps Continue off until something came in (a CSV import or `markCompleted`, e.g. a live sync). */
   protected readonly importBlocked: import("@angular/core").Signal<boolean>;
   /** The step's own two parts (`splitLayout`) show as two tabs, one card at a time; this is the open one (it starts on the app's part on every visit). */
-  protected readonly splitTab: import("@angular/core").WritableSignal<"main" | "extra">;
+  protected readonly splitTab: import("@angular/core").WritableSignal<"extra" | "main">;
   protected readonly splitTabs: import("@angular/core").Signal<{
     key: string;
     label: string;
@@ -11560,6 +11658,8 @@ export declare class SetupWizardComponent {
   readonly steps: import("@angular/core").InputSignal<SetupStep[]>;
   /** Replaces any of the built-in texts. */
   readonly texts: import("@angular/core").InputSignal<Partial<SetupWizardTexts>>;
+  /** The key of the step to open first (for example the one a payment provider's return address names); default (empty or unknown) = the first step. Read once, when the wizard starts. */
+  readonly initialStep: import("@angular/core").InputSignal<string>;
   /** The last step's button ("Go to Dashboard"). */
   readonly finished: import("@angular/core").OutputEmitterRef<void>;
   /** "Exit Setup". */
@@ -11579,6 +11679,12 @@ export declare class SetupWizardComponent {
   private readonly importErrors;
   private readonly statuses;
   readonly busy: import("@angular/core").WritableSignal<boolean>;
+  /** Key of the integration whose authorization address is being requested: only that card's button shows a loader (the footer's Save & Continue is not busy), and no second press starts a second connection. */
+  protected readonly connecting: import("@angular/core").WritableSignal<string>;
+  /** The blank tab opened on the Connect click (the click is the user gesture; the address arrives later), or null when none was opened / the browser blocked it. */
+  private pendingTab;
+  /** A provider's page was opened in another tab: when this tab becomes visible again the step's statuses are read again. */
+  private connectTabOpened;
   /** What a custom step's template receives (`let-wizard`). */
   protected readonly api: SetupWizardApi;
   protected readonly error: import("@angular/core").WritableSignal<string>;
@@ -11638,13 +11744,18 @@ export declare class SetupWizardComponent {
   protected isConnected(i: SetupIntegration): boolean;
   protected detailFor(i: SetupIntegration): string;
   protected connect(i: SetupIntegration): void;
+  /** Opens an empty tab for the provider's page (null when the browser refuses; the address then opens in this tab). */
+  protected openTab(): Window | null;
+  private closePendingTab;
   private startConnect;
   private isWebAddress;
   /** SVG path of a library icon (the buttons' leading / trailing glyph). */
   protected iconD(name: string): string;
   protected areaCodeLabelFor(i: SetupIntegration): string;
-  /** Sends the browser to the provider's authorization page. */
+  /** Opens the provider's authorization page: in the tab opened on the click, else (a blocked tab) in this one. */
   protected redirect(url: string): void;
+  /** Sends THIS tab to the address (no new tab was opened, the browser refused it or the user closed it). */
+  protected navigateHere(url: string): void;
   protected submitAreaCode(i: SetupIntegration): void;
   static ɵfac: i0.ɵɵFactoryDeclaration<SetupWizardComponent, never>;
   static ɵcmp: i0.ɵɵComponentDeclaration<SetupWizardComponent, "ui-setup-wizard", never, {
@@ -11658,6 +11769,11 @@ export declare class SetupWizardComponent {
       "required": false;
       "isSignal": true;
     };
+    "initialStep": {
+      "alias": "initialStep";
+      "required": false;
+      "isSignal": true;
+    };
   }, {
     "finished": "finished";
     "exited": "exited";