@ajf/material 18.4.0 → 18.5.0

package/forms/forms-module.d.ts

@@ -1,59 +1,65 @@
 import { ModuleWithProviders } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "./audio-field";
-import * as i2 from "./barcode-field";
-import * as i3 from "./boolean-field";
-import * as i4 from "./date-field";
-import * as i5 from "./date-input-field";
-import * as i6 from "./empty-field";
-import * as i7 from "./field-warning-dialog";
-import * as i8 from "./field";
-import * as i9 from "./form";
-import * as i10 from "./geolocation-field";
-import * as i11 from "./input-field";
-import * as i12 from "./multiple-choice-field";
-import * as i13 from "./range-field";
-import * as i14 from "./signature-field";
-import * as i15 from "./single-choice-field";
-import * as i16 from "./table-field";
-import * as i17 from "./text-field";
-import * as i18 from "./time-field";
-import * as i19 from "./video-url-field";
-import * as i20 from "./display-field";
-import * as i21 from "@ajf/material/audio";
-import * as i22 from "@ajf/material/barcode";
-import * as i23 from "@ajf/material/calendar";
-import * as i24 from "@ajf/core/common";
-import * as i25 from "@ajf/material/checkbox-group";
-import * as i26 from "@ajf/material/geolocation";
-import * as i27 from "@ajf/material/page-slider";
-import * as i28 from "@ajf/material/signature";
-import * as i29 from "@ajf/material/time";
-import * as i30 from "@ajf/core/transloco";
-import * as i31 from "@angular/common";
-import * as i32 from "@ajf/core/forms";
-import * as i33 from "@angular/material/button";
-import * as i34 from "@angular/material/button-toggle";
-import * as i35 from "@angular/material/card";
-import * as i36 from "@angular/material/datepicker";
-import * as i37 from "@angular/material/dialog";
-import * as i38 from "@angular/material/form-field";
-import * as i39 from "@angular/material/icon";
-import * as i40 from "@angular/material/input";
-import * as i41 from "@angular/material/core";
-import * as i42 from "@angular/material/radio";
-import * as i43 from "@angular/material/select";
-import * as i44 from "@angular/material/slide-toggle";
-import * as i45 from "@angular/material/toolbar";
-import * as i46 from "@angular/material/tooltip";
-import * as i47 from "@angular/forms";
-import * as i48 from "@angular/cdk/text-field";
-import * as i49 from "@angular/material/slider";
-import * as i50 from "ngx-mat-select-search";
-import * as i51 from "ngx-quill";
+import * as i2 from "./current-slide";
+import * as i3 from "./barcode-field";
+import * as i4 from "./boolean-field";
+import * as i5 from "./date-field";
+import * as i6 from "./date-input-field";
+import * as i7 from "./empty-field";
+import * as i8 from "./field-row";
+import * as i9 from "./field-warning-dialog";
+import * as i10 from "./field";
+import * as i11 from "./slide-stats";
+import * as i12 from "./form";
+import * as i13 from "./geolocation-field";
+import * as i14 from "./input-field";
+import * as i15 from "./multiple-choice-field";
+import * as i16 from "./range-field";
+import * as i17 from "./rep-strip";
+import * as i18 from "./signature-field";
+import * as i19 from "./single-choice-field";
+import * as i20 from "./slide-header";
+import * as i21 from "./table-field";
+import * as i22 from "./text-field";
+import * as i23 from "./time-field";
+import * as i24 from "./video-url-field";
+import * as i25 from "./display-field";
+import * as i26 from "@ajf/material/audio";
+import * as i27 from "@ajf/material/barcode";
+import * as i28 from "@ajf/material/calendar";
+import * as i29 from "@ajf/core/common";
+import * as i30 from "@ajf/material/checkbox-group";
+import * as i31 from "@ajf/material/geolocation";
+import * as i32 from "@ajf/material/page-slider";
+import * as i33 from "@ajf/material/signature";
+import * as i34 from "@ajf/material/time";
+import * as i35 from "@ajf/core/transloco";
+import * as i36 from "@angular/common";
+import * as i37 from "@ajf/core/forms";
+import * as i38 from "@angular/material/button";
+import * as i39 from "@angular/material/button-toggle";
+import * as i40 from "@angular/material/card";
+import * as i41 from "@angular/material/datepicker";
+import * as i42 from "@angular/material/dialog";
+import * as i43 from "@angular/material/form-field";
+import * as i44 from "@angular/material/icon";
+import * as i45 from "@angular/material/input";
+import * as i46 from "@angular/material/menu";
+import * as i47 from "@angular/material/core";
+import * as i48 from "@angular/material/radio";
+import * as i49 from "@angular/material/select";
+import * as i50 from "@angular/material/slide-toggle";
+import * as i51 from "@angular/material/toolbar";
+import * as i52 from "@angular/material/tooltip";
+import * as i53 from "@angular/forms";
+import * as i54 from "@angular/cdk/text-field";
+import * as i55 from "@angular/material/slider";
+import * as i56 from "ngx-mat-select-search";
+import * as i57 from "ngx-quill";
 export declare class AjfFormsModule {
     static forRoot(): ModuleWithProviders<AjfFormsModule>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AjfFormsModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<AjfFormsModule, [typeof i1.AjfAudioFieldComponent, typeof i2.AjfBarcodeFieldComponent, typeof i3.AjfBooleanFieldComponent, typeof i4.AjfDateFieldComponent, typeof i5.AjfDateInputFieldComponent, typeof i6.AjfEmptyFieldComponent, typeof i7.AjfFieldWarningDialog, typeof i8.AjfFormField, typeof i9.AjfFormRenderer, typeof i10.AjfGeolocationFieldComponent, typeof i11.AjfInputFieldComponent, typeof i12.AjfMultipleChoiceFieldComponent, typeof i13.AjfRangeFieldComponent, typeof i14.AjfSignatureFieldComponent, typeof i15.AjfSingleChoiceFieldComponent, typeof i16.AjfTableFieldComponent, typeof i17.AjfTextFieldComponent, typeof i18.AjfTimeFieldComponent, typeof i19.AjfVideoUrlFieldComponent, typeof i20.AjfDisplayFieldComponent], [typeof i21.AjfAudioModule, typeof i22.AjfBarcodeModule, typeof i23.AjfCalendarModule, typeof i24.AjfCommonModule, typeof i25.AjfCheckboxGroupModule, typeof i26.AjfGeolocationModule, typeof i27.AjfPageSliderModule, typeof i28.AjfSignatureModule, typeof i29.AjfTimeModule, typeof i30.AjfTranslocoModule, typeof i31.CommonModule, typeof i32.AjfFormsModule, typeof i33.MatButtonModule, typeof i34.MatButtonToggleModule, typeof i35.MatCardModule, typeof i36.MatDatepickerModule, typeof i37.MatDialogModule, typeof i38.MatFormFieldModule, typeof i39.MatIconModule, typeof i40.MatInputModule, typeof i41.MatNativeDateModule, typeof i42.MatRadioModule, typeof i43.MatSelectModule, typeof i44.MatSlideToggleModule, typeof i45.MatToolbarModule, typeof i46.MatTooltipModule, typeof i47.ReactiveFormsModule, typeof i48.TextFieldModule, typeof i49.MatSliderModule, typeof i50.NgxMatSelectSearchModule, typeof i51.QuillModule], [typeof i8.AjfFormField, typeof i9.AjfFormRenderer]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AjfFormsModule, [typeof i1.AjfAudioFieldComponent, typeof i2.AjfCurrentSlidePipe, typeof i3.AjfBarcodeFieldComponent, typeof i4.AjfBooleanFieldComponent, typeof i5.AjfDateFieldComponent, typeof i6.AjfDateInputFieldComponent, typeof i7.AjfEmptyFieldComponent, typeof i8.AjfFieldRow, typeof i9.AjfFieldWarningDialog, typeof i10.AjfFormField, typeof i11.AjfFormIssuesPipe, typeof i12.AjfFormRenderer, typeof i13.AjfGeolocationFieldComponent, typeof i14.AjfInputFieldComponent, typeof i15.AjfMultipleChoiceFieldComponent, typeof i16.AjfRangeFieldComponent, typeof i17.AjfRepStrip, typeof i18.AjfSignatureFieldComponent, typeof i19.AjfSingleChoiceFieldComponent, typeof i11.AjfSlideCompletionPipe, typeof i20.AjfSlideHeader, typeof i11.AjfSlideIssuesPipe, typeof i21.AjfTableFieldComponent, typeof i22.AjfTextFieldComponent, typeof i23.AjfTimeFieldComponent, typeof i24.AjfVideoUrlFieldComponent, typeof i25.AjfDisplayFieldComponent], [typeof i26.AjfAudioModule, typeof i27.AjfBarcodeModule, typeof i28.AjfCalendarModule, typeof i29.AjfCommonModule, typeof i30.AjfCheckboxGroupModule, typeof i31.AjfGeolocationModule, typeof i32.AjfPageSliderModule, typeof i33.AjfSignatureModule, typeof i34.AjfTimeModule, typeof i35.AjfTranslocoModule, typeof i36.CommonModule, typeof i37.AjfFormsModule, typeof i38.MatButtonModule, typeof i39.MatButtonToggleModule, typeof i40.MatCardModule, typeof i41.MatDatepickerModule, typeof i42.MatDialogModule, typeof i43.MatFormFieldModule, typeof i44.MatIconModule, typeof i45.MatInputModule, typeof i46.MatMenuModule, typeof i47.MatNativeDateModule, typeof i48.MatRadioModule, typeof i49.MatSelectModule, typeof i50.MatSlideToggleModule, typeof i51.MatToolbarModule, typeof i52.MatTooltipModule, typeof i53.ReactiveFormsModule, typeof i54.TextFieldModule, typeof i55.MatSliderModule, typeof i56.NgxMatSelectSearchModule, typeof i57.QuillModule], [typeof i8.AjfFieldRow, typeof i10.AjfFormField, typeof i12.AjfFormRenderer, typeof i17.AjfRepStrip, typeof i20.AjfSlideHeader]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<AjfFormsModule>;
 }

package/forms/multiple-choice-field.d.ts

@@ -21,17 +21,31 @@
  */
 import { AjfChoice, AjfFieldWithChoicesComponent, AjfFormRendererService } from '@ajf/core/forms';
 import { ChangeDetectorRef, OnDestroy } from '@angular/core';
-import { FormControl } from '@angular/forms';
+import { FormControl, UntypedFormControl } from '@angular/forms';
 import { Observable } from 'rxjs';
 import { AjfWarningAlertService } from './warning-alert-service';
 import * as i0 from "@angular/core";
 export declare class AjfMultipleChoiceFieldComponent<T> extends AjfFieldWithChoicesComponent<T> implements OnDestroy {
     readonly expandThreshold: number;
     readonly searchFilterCtrl: FormControl<string>;
+    /**
+     * Whether the choices collapse into a searchable dropdown. Below the search
+     * threshold they are laid out as buttons instead, which reads faster for a
+     * short list. `forceExpanded` wins over `forceNarrow`, so a schema can pin
+     * either presentation regardless of how many choices there are.
+     */
+    get isNarrow(): boolean;
     filteredChoices$: Observable<AjfChoice<any>[]>;
     private readonly _choicesUpdate$;
     private _instanceUpdateForChoicesSub;
     constructor(cdr: ChangeDetectorRef, service: AjfFormRendererService, was: AjfWarningAlertService, searchThreshold: number);
+    /** The label shown on a selection chip. */
+    labelFor(value: any): string;
+    /**
+     * Drop one value from the selection, from the chip's own button. The click has
+     * to be stopped from reaching the trigger, which would reopen the panel.
+     */
+    removeValue(ctrl: UntypedFormControl, value: any, event: Event): void;
     protected _onInstanceChange(): void;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AjfMultipleChoiceFieldComponent<any>, [null, null, null, { optional: true; }]>;

package/forms/public_api.d.ts

@@ -20,17 +20,22 @@
  *
  */
 export * from './boolean-field';
+export * from './current-slide';
 export * from './date-field';
 export * from './date-input-field';
 export * from './empty-field';
 export * from './field';
+export * from './field-row';
 export * from './field-service';
 export * from './field-warning-dialog';
 export * from './input-field';
 export * from './form';
 export * from './forms-module';
 export * from './multiple-choice-field';
+export * from './rep-strip';
 export * from './single-choice-field';
+export * from './slide-header';
+export * from './slide-stats';
 export * from './table-field';
 export * from './time-field';
 export * from './warning-alert-service';

package/forms/rep-strip.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright (C) Gnucoop soc. coop.
+ *
+ * This file is part of the Advanced JSON forms (ajf).
+ *
+ * Advanced JSON forms (ajf) is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ *
+ * Advanced JSON forms (ajf) is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Advanced JSON forms (ajf).
+ * If not, see http://www.gnu.org/licenses/.
+ *
+ */
+import { AjfRepeatingSlideInstance } from '@ajf/core/forms';
+import { BooleanInput } from '@angular/cdk/coercion';
+import { EventEmitter } from '@angular/core';
+import * as i0 from "@angular/core";
+/**
+ * The pager for a repeating slide: one button per repetition plus add and remove
+ * actions. The renderer keeps one page per repetition, so picking a number here
+ * is a page change, which the renderer performs.
+ */
+export declare class AjfRepStrip {
+    slide: AjfRepeatingSlideInstance;
+    /** The repetition currently on screen, zero based. */
+    current: number;
+    set readonly(readonly: boolean);
+    get readonly(): boolean;
+    private _readonly;
+    readonly goTo: EventEmitter<number>;
+    readonly add: EventEmitter<void>;
+    readonly remove: EventEmitter<void>;
+    /**
+     * A repetition count driven by a formula is not the reader's to change:
+     * `AjfFormRendererService.addGroup` and `removeGroup` both refuse the call
+     * outright, so without this the buttons would sit enabled and do nothing.
+     */
+    private get manualReps();
+    get canAdd(): boolean;
+    get canRemove(): boolean;
+    static ngAcceptInputType_readonly: BooleanInput;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AjfRepStrip, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AjfRepStrip, "ajf-rep-strip", never, { "slide": { "alias": "slide"; "required": false; }; "current": { "alias": "current"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "goTo": "goTo"; "add": "add"; "remove": "remove"; }, never, never, false, never>;
+}

package/forms/single-choice-field.d.ts

@@ -28,6 +28,13 @@ import * as i0 from "@angular/core";
 export declare class AjfSingleChoiceFieldComponent<T> extends AjfFieldWithChoicesComponent<T> implements OnDestroy {
     readonly expandThreshold: number;
     readonly searchFilterCtrl: FormControl<string>;
+    /**
+     * Whether the choices collapse into a searchable dropdown. Below the search
+     * threshold they are laid out as buttons instead, which reads faster for a
+     * short list. `forceExpanded` wins over `forceNarrow`, so a schema can pin
+     * either presentation regardless of how many choices there are.
+     */
+    get isNarrow(): boolean;
     filteredChoices$: Observable<AjfChoice<any>[]>;
     private readonly _choicesUpdate$;
     private _instanceUpdateForChoicesSub;

package/forms/slide-header.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @license
+ * Copyright (C) Gnucoop soc. coop.
+ *
+ * This file is part of the Advanced JSON forms (ajf).
+ *
+ * Advanced JSON forms (ajf) is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ *
+ * Advanced JSON forms (ajf) is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Advanced JSON forms (ajf).
+ * If not, see http://www.gnu.org/licenses/.
+ *
+ */
+import { AjfSlideInstance } from '@ajf/core/forms';
+import { EventEmitter } from '@angular/core';
+import * as i0 from "@angular/core";
+/**
+ * The bar at the top of every slide: its number and title, a menu to jump to any
+ * other slide, previous/next paging, and a slot for the form's own action
+ * buttons.
+ *
+ * What the form still has failing is reported by the footer alone. Naming it
+ * here too cost a phone's whole header width to repeat something already on
+ * screen.
+ *
+ * Paging belongs to the renderer, which owns the page slider, so it is raised
+ * as an event rather than handled here.
+ */
+export declare class AjfSlideHeader {
+    /** Absent while a start or end message page is on screen. */
+    slide: AjfSlideInstance | null;
+    /** The number shown in the badge, already offset by any start message. */
+    displayNumber: number;
+    /** Every slide of the form, for the jump menu. */
+    slides: AjfSlideInstance[];
+    /** How many pages the slider holds, repetitions and message pages included. */
+    pages: number;
+    /**
+     * Whether the form has anywhere to page to. A single page form gets no arrows
+     * and no "slide 1 of 1": both are controls that cannot do anything.
+     */
+    get canNavigate(): boolean;
+    /**
+     * Whether the jump menu is worth opening. Counted over the visible slides, the
+     * only ones the menu can actually reach.
+     */
+    get canJump(): boolean;
+    readonly jumpTo: EventEmitter<AjfSlideInstance>;
+    readonly prev: EventEmitter<void>;
+    readonly next: EventEmitter<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AjfSlideHeader, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AjfSlideHeader, "ajf-slide-header", never, { "slide": { "alias": "slide"; "required": false; }; "displayNumber": { "alias": "displayNumber"; "required": false; }; "slides": { "alias": "slides"; "required": false; }; "pages": { "alias": "pages"; "required": false; }; }, { "jumpTo": "jumpTo"; "prev": "prev"; "next": "next"; }, never, ["*"], false, never>;
+}

package/forms/slide-stats.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @license
+ * Copyright (C) Gnucoop soc. coop.
+ *
+ * This file is part of the Advanced JSON forms (ajf).
+ *
+ * Advanced JSON forms (ajf) is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ *
+ * Advanced JSON forms (ajf) is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Advanced JSON forms (ajf).
+ * If not, see http://www.gnu.org/licenses/.
+ *
+ */
+import { AjfBaseSlideInstance, AjfSlideInstance } from '@ajf/core/forms';
+import { PipeTransform } from '@angular/core';
+import { UntypedFormGroup } from '@angular/forms';
+import * as i0 from "@angular/core";
+/** The filled/total counter shown as a chip in the slide header. */
+export interface AjfSlideCompletion {
+    done: number;
+    total: number;
+}
+/**
+ * How many of a slide's fields carry a value, out of how many are on it. Notes
+ * (`AjfFieldType.Empty`) hold no value and are left out of both numbers.
+ *
+ * Impure because it reads mutable instance state, in the same way as
+ * `ajfValidSlide` and `ajfAsFieldInstanceErrors`. Returns a memoized object; see
+ * the note inside.
+ */
+export declare class AjfSlideCompletionPipe implements PipeTransform {
+    private _last;
+    transform(slide: AjfBaseSlideInstance, idx?: number, formGroup?: UntypedFormGroup | null): AjfSlideCompletion;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AjfSlideCompletionPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<AjfSlideCompletionPipe, "ajfSlideCompletion", false>;
+}
+/**
+ * How many of a slide's visible fields are failing validation.
+ */
+export declare class AjfSlideIssuesPipe implements PipeTransform {
+    transform(slide: AjfBaseSlideInstance, idx?: number): number;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AjfSlideIssuesPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<AjfSlideIssuesPipe, "ajfSlideIssues", false>;
+}
+/** What is left to fix in the whole form, for the header and footer alerts. */
+export interface AjfFormIssues {
+    /** Visible fields failing validation, across every slide and repetition. */
+    fields: number;
+    /** How many slides hold at least one of them. */
+    slides: number;
+}
+/**
+ * The form's outstanding work in one place. A per-slide count only tells the
+ * reader about the slide they are already looking at, which is the one place
+ * they can see the failing fields for themselves.
+ *
+ * Counted here rather than taken from `AjfFormRendererService.errors`, which
+ * counts invalid slide pages and says nothing about how many fields are behind
+ * them.
+ *
+ * Impure and memoized, like its neighbours above.
+ */
+export declare class AjfFormIssuesPipe implements PipeTransform {
+    private _last;
+    transform(slides: AjfSlideInstance[] | null): AjfFormIssues;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AjfFormIssuesPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<AjfFormIssuesPipe, "ajfFormIssues", false>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ajf/material",
-  "version": "18.4.0",
+  "version": "18.5.0",
   "description": "",
   "repository": {
     "type": "git",
@@ -13,7 +13,7 @@
   },
   "homepage": "https://github.com/gnucoop/ajf#readme",
   "peerDependencies": {
-    "@ajf/core": "18.4.0",
+    "@ajf/core": "18.5.0",
     "@angular/animations": "^18.2.13",
     "@angular/cdk": "^18.2.14",
     "@angular/common": "^18.2.13",

package/time/time-module.d.ts

@@ -3,10 +3,11 @@ import * as i1 from "./time";
 import * as i2 from "@angular/common";
 import * as i3 from "@angular/forms";
 import * as i4 from "@angular/material/form-field";
-import * as i5 from "@angular/material/input";
-import * as i6 from "@angular/material/select";
+import * as i5 from "@angular/material/icon";
+import * as i6 from "@angular/material/input";
+import * as i7 from "@angular/material/select";
 export declare class AjfTimeModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<AjfTimeModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<AjfTimeModule, [typeof i1.AjfTime], [typeof i2.CommonModule, typeof i3.FormsModule, typeof i4.MatFormFieldModule, typeof i5.MatInputModule, typeof i6.MatSelectModule], [typeof i1.AjfTime]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AjfTimeModule, [typeof i1.AjfTime], [typeof i2.CommonModule, typeof i3.FormsModule, typeof i4.MatFormFieldModule, typeof i5.MatIconModule, typeof i6.MatInputModule, typeof i7.MatSelectModule], [typeof i1.AjfTime]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<AjfTimeModule>;
 }