@rdlabo/ionic-angular-kit 0.0.12 → 0.0.13

package/types/rdlabo-ionic-angular-kit.d.ts

@@ -1,9 +1,10 @@
 import * as i0 from '@angular/core';
-import { InjectionToken, EnvironmentProviders, OnInit, ElementRef } from '@angular/core';
-import { ModalOptions, PopoverOptions, ToastOptions, AlertController } from '@ionic/angular/standalone';
+import { InjectionToken, EnvironmentProviders, OnInit, ElementRef, WritableSignal } from '@angular/core';
+import { ModalOptions, PopoverOptions, ToastOptions, AlertController, ActionSheetController } from '@ionic/angular/standalone';
 import { PluginListenerHandle } from '@capacitor/core';
+import { BehaviorSubject, Observable } from 'rxjs';
+import { BRLMPrinterModelName, BRLMPrinterLabelName, BRLMPrintOptions } from '@rdlabo/capacitor-brotherprint';
 import { RouterStateSnapshot, UrlTree, CanActivateFn } from '@angular/router';
-import { Observable } from 'rxjs';
 import { HttpRequest, HttpResponse, HttpErrorResponse, HttpEvent, HttpInterceptorFn } from '@angular/common/http';
 import { ImpactStyle } from '@capacitor/haptics';
 
@@ -402,6 +403,70 @@ interface KitAuthFailedAlertOptions {
  */
 declare const kitPresentAuthFailedAlert: (alertCtrl: AlertController, options: KitAuthFailedAlertOptions) => Promise<void>;
 
+/** One selectable language in {@link kitPresentLanguageActionSheet}. */
+interface KitLanguageOption {
+    /** Button label shown to the user (e.g. `English`, `日本語`). */
+    readonly text: string;
+    /** Locale identifier returned when this option is chosen (e.g. `en-US`, `ja`). */
+    readonly data: string;
+}
+/**
+ * Options for {@link kitPresentLanguageActionSheet}.
+ *
+ * @remarks
+ * The kit ships no strings or URLs of its own: labels, the locale list, and the redirect-URL mapping
+ * are all supplied by the caller, so a multilingual app passes `$localize`-resolved text and its own
+ * per-locale build paths.
+ */
+interface KitLanguageActionSheetOptions {
+    /** Action-sheet header text. */
+    readonly header: string;
+    /** Selectable languages, in display order. */
+    readonly locales: readonly KitLanguageOption[];
+    /** Text for the cancel button. */
+    readonly cancelText: string;
+    /** The currently active locale; selecting the same value is a no-op. Normalize before passing. */
+    readonly currentLocale: string;
+    /** The current in-app path (e.g. `router.url`), stashed so the app can restore it after the reload. */
+    readonly currentPath: string;
+    /** `sessionStorage` key under which {@link currentPath} is stored. */
+    readonly pathnameStorageKey: string;
+    /** Maps a chosen locale to the URL to navigate to (the app's per-locale build entry point). */
+    readonly buildRedirectUrl: (locale: string) => string;
+    /** Gate for the redirect — pass `false` (e.g. outside production) to present without navigating. */
+    readonly enabled: boolean;
+}
+/**
+ * Present a language picker and, on a new selection, reload the app at that locale's entry point.
+ *
+ * @remarks
+ * A plain function (the `ActionSheetController` is passed in, so nothing is injected) that unifies the
+ * language-switch flow duplicated across apps. On a changed selection while {@link enabled} it stashes
+ * the current path in `sessionStorage` (so the app can return the user to where they were), records the
+ * chosen locale in `localStorage` under `'locale'`, and calls `window.location.replace()` with the
+ * app-provided URL. Because it performs navigation, it is a standalone helper rather than part of a
+ * controller (mirroring `kitPresentReloadAlert` / `kitPresentAuthFailedAlert`). Centralizing it means a
+ * future improvement to the switch flow lands in every app at once.
+ *
+ * @param actionSheetCtrl - the Ionic `ActionSheetController`
+ * @param options - labels, locale list, and redirect configuration; see {@link KitLanguageActionSheetOptions}
+ * @returns a Promise that resolves once presented (and, on a new selection, after the reload is triggered)
+ * @example
+ * ```ts
+ * await kitPresentLanguageActionSheet(inject(ActionSheetController), {
+ *   header: $localize`言語設定`,
+ *   locales: [{ text: 'English', data: 'en-US' }, { text: '日本語', data: 'ja' }],
+ *   cancelText: $localize`キャンセル`,
+ *   currentLocale: normalizedLocale,
+ *   currentPath: this.#router.url,
+ *   pathnameStorageKey: StorageKeyEnum.pathnameBeforeRedirect,
+ *   buildRedirectUrl: (locale) => location.origin + (localePath[locale.toLowerCase()] ?? '/index.html'),
+ *   enabled: environment.production,
+ * });
+ * ```
+ */
+declare const kitPresentLanguageActionSheet: (actionSheetCtrl: ActionSheetController, options: KitLanguageActionSheetOptions) => Promise<void>;
+
 /**
  * Work around iOS `ion-input` autofill values not propagating to the Angular form model.
  *
@@ -485,6 +550,236 @@ type KitKeyboardAdjust = 'transform' | 'offset' | 'keyboard-offset';
  */
 declare const kitKeyboardInit: (elementRef: ElementRef, type: KitKeyboardAdjust) => Promise<PluginListenerHandle[]>;
 
+/**
+ * Theme configuration injected via `provideKitTheme()` and consumed by `KitThemeController`.
+ *
+ * @remarks
+ * All fields are required; the consuming application supplies a complete configuration so every app
+ * in the fleet has the same shape. The class lists absorb the per-app CSS drift: the kit toggles
+ * `darkClasses` on when dark and `lightClasses` on when light, so an app that only uses Ionic's
+ * palette passes `darkClasses: ['ion-palette-dark'], lightClasses: []`, while an app with an extra
+ * design-system palette adds its own classes (e.g. `darkClasses: ['ion-palette-dark', 'a2ui-dark']`,
+ * `lightClasses: ['a2ui-light']`).
+ */
+interface KitThemeConfig {
+    /** Key under which the chosen theme (`'light'` | `'dark'`) is persisted via `KitStorageService`. */
+    readonly storageKey: string;
+    /** Classes toggled **on** the document element when the dark theme is active. */
+    readonly darkClasses: readonly string[];
+    /** Classes toggled **on** the document element when the light theme is active. */
+    readonly lightClasses: readonly string[];
+}
+/**
+ * Injection token carrying the {@link KitThemeConfig} for `KitThemeController`.
+ *
+ * @remarks
+ * Provide it through {@link provideKitTheme} rather than registering it directly.
+ */
+declare const KIT_THEME_CONFIG: InjectionToken<KitThemeConfig>;
+/**
+ * Wire `KitThemeController` into the application.
+ *
+ * @param config - theme configuration: the storage key and the light/dark class lists
+ * @returns environment providers to add to the application's provider list
+ * @example
+ * ```ts
+ * bootstrapApplication(AppComponent, {
+ *   providers: [
+ *     provideKitTheme({
+ *       storageKey: StorageKeyEnum.theme,
+ *       darkClasses: ['ion-palette-dark', 'a2ui-dark'],
+ *       lightClasses: ['a2ui-light'],
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const provideKitTheme: (config: KitThemeConfig) => EnvironmentProviders;
+
+/** The active theme mode. */
+type KitThemeMode = 'light' | 'dark';
+/**
+ * Light/dark theme controller: persists the user's choice, follows the OS setting until the user
+ * overrides it, toggles the configured palette classes, and syncs the native Android status bar.
+ *
+ * @remarks
+ * Consolidates the theme logic that had drifted across the fleet into one behavior. Notably it fixes
+ * a latent leak in one variant where the system-theme listener stayed registered after a manual
+ * toggle: {@link changeTheme} always detaches the listener via {@link removeEventListener} before
+ * applying the forced theme, so a later OS change can no longer silently flip an app the user pinned.
+ *
+ * - **Persistence** — the chosen mode is stored via {@link KitStorageService} under the configured key.
+ * - **Follow OS until overridden** — on boot with nothing stored, it tracks
+ *   `prefers-color-scheme` (idempotent registration); once the user calls {@link changeTheme} it stops
+ *   following and honors the explicit choice.
+ * - **Class toggling** — toggles {@link KitThemeConfig.darkClasses} on when dark and
+ *   {@link KitThemeConfig.lightClasses} on when light, absorbing per-app CSS differences via config.
+ * - **Native status bar** — on Android native only, mirrors the Ionic behavior of setting the status
+ *   bar style to match (iOS derives it from the web content, so it is intentionally left untouched).
+ *
+ * Subscribe to {@link themeSubject} to reflect the current mode in the UI (e.g. a settings toggle).
+ *
+ * @example
+ * ```ts
+ * // On boot (app.component):
+ * inject(KitThemeController).setDefaultThemeMode();
+ *
+ * // From a settings toggle:
+ * const theme = inject(KitThemeController);
+ * theme.themeSubject.subscribe((mode) => this.isDark.set(mode === 'dark'));
+ * theme.changeTheme(true);
+ * ```
+ */
+declare class KitThemeController {
+    #private;
+    /**
+     * Emits the active theme, seeded with `'light'`.
+     *
+     * @remarks
+     * A `BehaviorSubject`, so a late subscriber immediately receives the current mode; it emits again
+     * on every {@link setDefaultThemeMode} / {@link changeTheme} and on OS theme changes while following.
+     */
+    readonly themeSubject: BehaviorSubject<KitThemeMode>;
+    /**
+     * Apply the persisted theme, or start following the OS setting when nothing is stored yet.
+     *
+     * @remarks
+     * Call once on boot (e.g. from `app.component`).
+     *
+     * @returns a Promise that resolves once the initial theme has been applied
+     */
+    setDefaultThemeMode(): Promise<void>;
+    /**
+     * Force a theme, persist it, and stop following the OS setting.
+     *
+     * @param isDark - `true` for the dark theme, `false` for light
+     * @returns a Promise that resolves once the theme has been persisted and applied
+     */
+    changeTheme(isDark: boolean): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<KitThemeController, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<KitThemeController>;
+}
+
+/**
+ * Options for {@link kitRequestReview}.
+ */
+interface KitRequestReviewOptions {
+    /**
+     * Key under which the timestamp of the last review request is stored (via `@capacitor/preferences`).
+     *
+     * @remarks
+     * Supplied by the caller so the kit ships no storage keys of its own; each app passes its own enum
+     * value.
+     */
+    readonly storageKey: string;
+    /**
+     * Minimum number of months between review prompts.
+     *
+     * @remarks
+     * A prompt is only shown when this much time has elapsed since the last one (or when there is no
+     * record yet), so the OS review dialog is never nagged repeatedly.
+     */
+    readonly throttleMonths: number;
+}
+/**
+ * Request the native in-app review dialog, throttled so the user is prompted at most once per window.
+ *
+ * @remarks
+ * A plain function — no DI needed (`@capacitor/preferences`, `@capacitor-community/in-app-review` and
+ * `Capacitor` are all static), so the caller invokes it directly and passes its own config rather
+ * than injecting a controller. A no-op on non-native platforms. When enough time has elapsed since
+ * the last prompt (per {@link KitRequestReviewOptions.throttleMonths}, tracked under
+ * {@link KitRequestReviewOptions.storageKey}), it briefly waits for the app to settle, calls
+ * `InAppReview.requestReview()`, and records the new timestamp. The wait/throttle/record sequence
+ * was previously copy-pasted verbatim across the fleet; centralizing it means a single place to tune
+ * the prompt cadence.
+ *
+ * @param options - the storage key and throttle window; see {@link KitRequestReviewOptions}
+ * @returns a Promise that resolves once the request has been made (or immediately if throttled / on web)
+ * @example
+ * ```ts
+ * await kitRequestReview({ storageKey: StorageEnum.lastRequestRate, throttleMonths: 3 });
+ * ```
+ */
+declare const kitRequestReview: (options: KitRequestReviewOptions) => Promise<void>;
+
+/**
+ * Rotate a base64 image 90°, returning a new base64 data URL of the same MIME type.
+ *
+ * @remarks
+ * Pure DOM/canvas work — no DI. Used before sending a label to the printer when the artwork must be
+ * turned to match the tape orientation. Extracted verbatim from the fleet's printer services so the
+ * canvas handling lives in one place.
+ *
+ * @param imageData - a base64 data URL (e.g. `data:image/png;base64,...`)
+ * @returns a Promise resolving to the rotated image as a base64 data URL
+ */
+declare const kitRotationImage: (imageData: string) => Promise<string>;
+/** Options for {@link kitDomToPng}. */
+interface KitDomToPngOptions {
+    /** When `true`, the rendered PNG is rotated 90° via {@link kitRotationImage}. Defaults to `false`. */
+    readonly rotate?: boolean;
+    /** Rendering scale passed to `dom-to-image-more`. Defaults to `3` (the fleet's print resolution). */
+    readonly scale?: number;
+}
+/**
+ * Render a DOM element to a base64 PNG for label printing, with the fleet's device-specific fixes.
+ *
+ * @remarks
+ * Pure function — no DI (reads the platform from `Capacitor`, uses the global `document`), so the
+ * caller presents its own loading UI around it. Centralizes the hard-won device quirks: on iOS it
+ * pads width/height by 2px (otherwise the bottom is clipped), on Android it does not (the padding
+ * introduces a black line). Retries the `dom-to-image-more` render up to 10 times because the first
+ * pass can occasionally return empty. This is exactly the kind of plumbing where a future fix should
+ * land in every app at once.
+ *
+ * @param element - the element to rasterize (e.g. the label preview host)
+ * @param options - rendering options; see {@link KitDomToPngOptions}
+ * @returns a Promise resolving to the PNG as a base64 data URL (empty string if every attempt failed)
+ * @example
+ * ```ts
+ * const loading = await this.#loadingCtrl.create({ message: this.text.generating });
+ * await loading.present();
+ * const png = await kitDomToPng(this.preview().nativeElement, { rotate: true });
+ * await loading.dismiss();
+ * ```
+ */
+declare const kitDomToPng: (element: HTMLElement, options?: KitDomToPngOptions) => Promise<string>;
+/** Parameters for {@link kitBuildBrotherPrintSettings}. */
+interface KitBrotherPrintSettingsParams {
+    /** The target printer model. */
+    readonly modelName: BRLMPrinterModelName;
+    /** The label artwork as a base64 data URL (the `data:...,` prefix is stripped internally). */
+    readonly printBase64: string;
+    /** The selected label/paper (its `W<width>H<height>` code drives the tape dimensions). */
+    readonly label: BRLMPrinterLabelName;
+    /** Number of copies to print. Passed by the caller (apps differ: some use the print option, some fix 1). */
+    readonly numberOfCopies: number;
+    /** Halftone threshold for the print. */
+    readonly halftoneThreshold: number;
+}
+/**
+ * Assemble the Brother `BRLMPrintOptions` for a die-cut label print, minus the transport fields.
+ *
+ * @remarks
+ * Pure function — no DI. Centralizes the fleet's canonical print settings (fit-page scale, centered,
+ * best quality, threshold halftone, 2mm/1mm margins, `gapLength` 2.0) and the tape sizing derived
+ * from the label's `W<width>H<height>` code. The caller merges the printer's `port` / `channelInfo`
+ * onto the result before calling `BrotherPrint.printImage()`, so channel selection and loading UI stay
+ * in the app.
+ *
+ * @param params - model, artwork, label, copies, and halftone threshold; see {@link KitBrotherPrintSettingsParams}
+ * @returns the `BRLMPrintOptions` ready to be spread with `{ port, channelInfo }`
+ * @example
+ * ```ts
+ * const settings = kitBuildBrotherPrintSettings({
+ *   modelName, printBase64, label, numberOfCopies: printOptions.printNum, halftoneThreshold: printOptions.halftoneThreshold,
+ * });
+ * await BrotherPrint.printImage({ ...settings, port: channel.port, channelInfo: channel.channelInfo });
+ * ```
+ */
+declare const kitBuildBrotherPrintSettings: (params: KitBrotherPrintSettingsParams) => BRLMPrintOptions;
+
 /**
  * Discriminated set of authentication states the guards react to.
  *
@@ -996,5 +1291,45 @@ declare const objectEqual: (a: object, b: object) => boolean;
  */
 declare const disableHandler: (event: Event, work: Promise<void | boolean>) => Promise<void>;
 
-export { KIT_AUTH_CONFIG, KIT_HTTP_CONFIG, KIT_OVERLAY_CONFIG, KitAutofillDirective, KitOverlayController, KitReloadAlertController, KitStorageService, arrayConcatById, disableHandler, kitAuthInterceptor, kitImpact, kitKeyboardInit, kitPresentAuthFailedAlert, kitRequireAuthorizedGuard, kitRequireConfirmingGuard, kitRequiredUnauthorizedGuard, objectEqual, provideKitAuth, provideKitHttp, provideKitOverlay };
-export type { KitAlertCloseOptions, KitAlertConfirmOptions, KitAuthConfig, KitAuthFailedAlertOptions, KitAuthRedirects, KitAuthState, KitHttpConfig, KitKeyboardAdjust, KitLabels, KitModalPresentOptions, KitOverlayConfig, KitReloadAlertOptions };
+/**
+ * Toggle the `disabled` flag of a signal-held `ion-infinite-scroll` / `ion-refresher` element.
+ *
+ * @remarks
+ * A tiny pure helper for the common pattern of stashing the completing scroll/refresher element in a
+ * signal (e.g. captured from the event) and later enabling/disabling it — for instance disabling
+ * infinite scroll once the last page has loaded. A no-op when the signal holds no element.
+ *
+ * @param completeEvent - a writable signal holding the infinite-scroll / refresher element (or nullish)
+ * @param disabled - the value to set on the element's `disabled` property
+ * @example
+ * ```ts
+ * const infinite = signal<HTMLIonInfiniteScrollElement | null>(null);
+ * // ...on ionInfinite: infinite.set(ev.target); ...when no more pages:
+ * kitChangeEventDisabled(infinite, true);
+ * ```
+ */
+declare const kitChangeEventDisabled: (completeEvent: WritableSignal<HTMLIonInfiniteScrollElement | HTMLIonRefresherElement | null | undefined>, disabled: boolean) => void;
+
+/**
+ * Observe an Ionic page's "is currently entered" state from its lifecycle DOM events.
+ *
+ * @remarks
+ * Emits `true` on `ionViewDidEnter` and `false` on `ionViewWillEnter` / `ionViewWillLeave`, seeded
+ * with `false` via `startWith`. Useful to pause/resume work (timers, video, expensive rendering)
+ * while a page is off-screen in Ionic's stack navigation, without wiring the four lifecycle hooks by
+ * hand. The listeners are removed when the Observable is unsubscribed.
+ *
+ * @param el - an `ElementRef` for the page host element (the `ion-page`)
+ * @returns an Observable that emits whether the page is currently entered
+ * @example
+ * ```ts
+ * export class FeedPage {
+ *   readonly #host = inject(ElementRef);
+ *   readonly isEntered = toSignal(kitCreateDidEnter(this.#host), { initialValue: false });
+ * }
+ * ```
+ */
+declare const kitCreateDidEnter: (el: ElementRef) => Observable<boolean>;
+
+export { KIT_AUTH_CONFIG, KIT_HTTP_CONFIG, KIT_OVERLAY_CONFIG, KIT_THEME_CONFIG, KitAutofillDirective, KitOverlayController, KitReloadAlertController, KitStorageService, KitThemeController, arrayConcatById, disableHandler, kitAuthInterceptor, kitBuildBrotherPrintSettings, kitChangeEventDisabled, kitCreateDidEnter, kitDomToPng, kitImpact, kitKeyboardInit, kitPresentAuthFailedAlert, kitPresentLanguageActionSheet, kitRequestReview, kitRequireAuthorizedGuard, kitRequireConfirmingGuard, kitRequiredUnauthorizedGuard, kitRotationImage, objectEqual, provideKitAuth, provideKitHttp, provideKitOverlay, provideKitTheme };
+export type { KitAlertCloseOptions, KitAlertConfirmOptions, KitAuthConfig, KitAuthFailedAlertOptions, KitAuthRedirects, KitAuthState, KitBrotherPrintSettingsParams, KitDomToPngOptions, KitHttpConfig, KitKeyboardAdjust, KitLabels, KitLanguageActionSheetOptions, KitLanguageOption, KitModalPresentOptions, KitOverlayConfig, KitReloadAlertOptions, KitRequestReviewOptions, KitThemeConfig, KitThemeMode };