@yomotech/view-toolkit 1.0.52 → 1.0.56
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/yomotech-view-toolkit-catalog.mjs +519 -37
- package/fesm2022/yomotech-view-toolkit-catalog.mjs.map +1 -1
- package/fesm2022/yomotech-view-toolkit.mjs +838 -149
- package/fesm2022/yomotech-view-toolkit.mjs.map +1 -1
- package/package.json +3 -2
- package/types/yomotech-view-toolkit-catalog.d.ts +191 -50
- package/types/yomotech-view-toolkit.d.ts +167 -7
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as i0 from '@angular/core';
|
|
2
|
-
import { EventEmitter, ElementRef, ChangeDetectorRef, NgZone, SimpleChanges, OnInit, OnChanges, AfterViewInit, OnDestroy, Injector, PipeTransform } from '@angular/core';
|
|
2
|
+
import { EventEmitter, ElementRef, ChangeDetectorRef, NgZone, SimpleChanges, OnInit, OnChanges, DoCheck, AfterViewInit, OnDestroy, Injector, PipeTransform } from '@angular/core';
|
|
3
3
|
import * as i1 from '@angular/common';
|
|
4
4
|
import { CdkDragMove, CdkDragDrop } from '@angular/cdk/drag-drop';
|
|
5
5
|
import * as rxjs from 'rxjs';
|
|
@@ -345,7 +345,7 @@ declare class CardDesigner {
|
|
|
345
345
|
edit(index: number, parentIndex: number | null): void;
|
|
346
346
|
}
|
|
347
347
|
|
|
348
|
-
type DesignAction = 'drag' | 'add' | 'edit' | 'delete';
|
|
348
|
+
type DesignAction = 'drag' | 'add' | 'data' | 'edit' | 'delete';
|
|
349
349
|
/**
|
|
350
350
|
* The handles of one element. "drag" is the cdkDragHandle of the element it stands in; the others report their
|
|
351
351
|
* action (act) without the click reaching the element.
|
|
@@ -355,6 +355,8 @@ declare class DesignBarComponent {
|
|
|
355
355
|
/** the tooltip of each handle */
|
|
356
356
|
titles: Partial<Record<DesignAction, string>>;
|
|
357
357
|
act: EventEmitter<DesignAction>;
|
|
358
|
+
/** The handles in the one order, whatever order a container names them in. */
|
|
359
|
+
get ordered(): DesignAction[];
|
|
358
360
|
icon(action: DesignAction): string;
|
|
359
361
|
static ɵfac: i0.ɵɵFactoryDeclaration<DesignBarComponent, never>;
|
|
360
362
|
static ɵcmp: i0.ɵɵComponentDeclaration<DesignBarComponent, "vl-design-bar", never, { "actions": { "alias": "actions"; "required": false; }; "titles": { "alias": "titles"; "required": false; }; }, { "act": "act"; }, never, never, true, never>;
|
|
@@ -434,11 +436,21 @@ declare class RequestService {
|
|
|
434
436
|
static ɵprov: i0.ɵɵInjectableDeclaration<RequestService>;
|
|
435
437
|
}
|
|
436
438
|
|
|
439
|
+
/** A data_url that names fields of the form ({{form.x}}) - it depends on them. */
|
|
440
|
+
declare function dependsOnForm(url: unknown): boolean;
|
|
441
|
+
/** Every {{form.x}} of the address has a value in the context (an empty one loads nothing). */
|
|
442
|
+
declare function formValuesGiven(url: string, context: {
|
|
443
|
+
form: Record<string, any>;
|
|
444
|
+
}): boolean;
|
|
437
445
|
declare class UtilityService {
|
|
438
446
|
private platform;
|
|
439
447
|
private requestService;
|
|
440
448
|
stripe: any;
|
|
441
449
|
cardElement: any;
|
|
450
|
+
/** the Stripe key of the card field the page mounted - a test card is taken only with a test key */
|
|
451
|
+
private stripeKey;
|
|
452
|
+
/** a test run's Stripe test payment method (useTestCard) - paid with instead of the card frame */
|
|
453
|
+
private testPaymentMethod;
|
|
442
454
|
/** Stripe says the card field holds a whole card (number, date, CVC) - a signal, so a locked button follows it */
|
|
443
455
|
readonly cardComplete: i0.WritableSignal<boolean>;
|
|
444
456
|
constructor(platform: Platform, requestService: RequestService);
|
|
@@ -528,6 +540,15 @@ declare class UtilityService {
|
|
|
528
540
|
* the Angular form (Stripe's own frame), so the form's validity does not see it.
|
|
529
541
|
*/
|
|
530
542
|
requiredCardMissing(layoutSchema: any, propertySchema: any): boolean;
|
|
543
|
+
/**
|
|
544
|
+
* A test run's card: the card number of the test data ("4242 4242 4242 4242") becomes Stripe's test payment method
|
|
545
|
+
* for it - nobody can type into Stripe's own frame. Only with a test key and a Stripe test card; the card then
|
|
546
|
+
* counts as whole. ok false with the reason otherwise.
|
|
547
|
+
*/
|
|
548
|
+
useTestCard(cardNumber: string): {
|
|
549
|
+
ok: boolean;
|
|
550
|
+
error?: string;
|
|
551
|
+
};
|
|
531
552
|
/**
|
|
532
553
|
* Pays a payment intent with the card field of the page. ok false with the reason in error when the
|
|
533
554
|
* field is not there yet or Stripe refuses the card; the card data never leaves Stripe's own frame.
|
|
@@ -538,6 +559,21 @@ declare class UtilityService {
|
|
|
538
559
|
paymentIntent?: any;
|
|
539
560
|
}>;
|
|
540
561
|
formData(form: any, environment: any, cartInfo: any): Promise<void>;
|
|
562
|
+
/** The environment of the form loaded last - its dependent dropdowns load from env.apiUrl. */
|
|
563
|
+
private formEnvironment;
|
|
564
|
+
/** A dependent dropdown's address loading now - one call per address at a time. */
|
|
565
|
+
private dependentLoading;
|
|
566
|
+
/**
|
|
567
|
+
* The values of the form for its placeholders: {{form.<group>.<field>}}. A dropdown's value is its chosen option, so
|
|
568
|
+
* {{form.shipping.country.code}} names a field of it; on its own it reads as the chosen value.
|
|
569
|
+
*/
|
|
570
|
+
formPlaceholderContext(form: any): Record<string, any>;
|
|
571
|
+
/**
|
|
572
|
+
* The dropdowns whose data_url names fields of the form: loaded with the values of now when the address changed;
|
|
573
|
+
* a field still empty loads nothing (an empty list), a choice the new list no longer offers is cleared. Called after
|
|
574
|
+
* the form loaded and on every change of the form (FormComponent.ngDoCheck) - cheap when nothing changed.
|
|
575
|
+
*/
|
|
576
|
+
refreshDependentDropdowns(form: any): Promise<void>;
|
|
541
577
|
normalizeDatesForStorage(obj: any): any;
|
|
542
578
|
isDateLike(value: any): boolean;
|
|
543
579
|
toLocalISOString(date: Date): string;
|
|
@@ -731,8 +767,23 @@ declare class CustomKeyboardService {
|
|
|
731
767
|
* does not move.
|
|
732
768
|
*/
|
|
733
769
|
private scrollTargetAboveKeyboard;
|
|
770
|
+
/** The area a page scrolls in while the keyboard is open: its own bottom padding, how far it was moved. */
|
|
771
|
+
private pageRoom;
|
|
772
|
+
/**
|
|
773
|
+
* A field on a page: the area the page scrolls in gets room at its foot (the keyboard's height) and is moved just
|
|
774
|
+
* far enough that the field stands above the keyboard. A field already above it does not move.
|
|
775
|
+
*/
|
|
776
|
+
private pageFieldAboveKeyboard;
|
|
777
|
+
/** The keyboard closed: the page's area loses the room and stands where it stood before. */
|
|
778
|
+
private releasePageRoom;
|
|
734
779
|
private canProcessKeyboardAction;
|
|
735
780
|
insert(character: string): void;
|
|
781
|
+
/**
|
|
782
|
+
* The clipboard's text into the field at the cursor - the field is read-only while the keyboard is open (no system
|
|
783
|
+
* keyboard), so the browser's own paste does not reach it. The tap on the key is the person's own action, so the
|
|
784
|
+
* browser lets the clipboard be read (some ask first). Typed rules apply (insert); a refused read changes nothing.
|
|
785
|
+
*/
|
|
786
|
+
paste(): Promise<void>;
|
|
736
787
|
backspace(): void;
|
|
737
788
|
clear(): void;
|
|
738
789
|
/**
|
|
@@ -913,6 +964,16 @@ interface DataSource {
|
|
|
913
964
|
type StorageKind = 'localstorage' | 'sessionstorage' | 'filter' | 'database' | '';
|
|
914
965
|
/** The kind of a data source, lowercase - "localStorage" of older Designer versions counts as "localstorage". */
|
|
915
966
|
declare function storageKind(source: DataSource | null | undefined): StorageKind;
|
|
967
|
+
/**
|
|
968
|
+
* The list after a button that keeps one record: the record comes first; with key, a record of the same key
|
|
969
|
+
* value goes out instead (added: false). max: the oldest fall off the end.
|
|
970
|
+
*/
|
|
971
|
+
declare function toggleRecord(records: any[], record: any, key?: string, max?: number): {
|
|
972
|
+
records: any[];
|
|
973
|
+
added: boolean;
|
|
974
|
+
};
|
|
975
|
+
/** The web address a button opens: the field option.propertyKey of the record, only http(s). */
|
|
976
|
+
declare function linkOfRecord(option: any, record: any): string | null;
|
|
916
977
|
/** True when the records of the source live in the browser (local or session storage). */
|
|
917
978
|
declare function isBrowserSource(source: DataSource | null | undefined): boolean;
|
|
918
979
|
/**
|
|
@@ -1022,6 +1083,8 @@ declare class PageData {
|
|
|
1022
1083
|
* sends all in one call (all taken or all refused). OFFENE-PUNKTE 131: a refused entry looked like one never sent.
|
|
1023
1084
|
*/
|
|
1024
1085
|
send(button: any, index: number | 'all'): Promise<boolean>;
|
|
1086
|
+
/** A button with a browser storage: its record goes into the button's list, or out again (toggleRecord). */
|
|
1087
|
+
keep(button: any, record: any): Promise<boolean>;
|
|
1025
1088
|
/** Filter fields are the keys set by setFilter; a filter page loads only when none is empty. */
|
|
1026
1089
|
private filterComplete;
|
|
1027
1090
|
private loadBackendRecords;
|
|
@@ -1127,6 +1190,8 @@ declare class CardComponent {
|
|
|
1127
1190
|
get displayedRecords(): any[];
|
|
1128
1191
|
private setupScrollObserver;
|
|
1129
1192
|
private loadNextScrollPage;
|
|
1193
|
+
/** No further page to load - the list's end marks itself for tests (data-vl-list-end). */
|
|
1194
|
+
listEnd(): boolean;
|
|
1130
1195
|
private hasNextScrollPage;
|
|
1131
1196
|
private refreshScrollObserver;
|
|
1132
1197
|
private destroyScrollObserver;
|
|
@@ -1167,9 +1232,11 @@ declare class CardComponent {
|
|
|
1167
1232
|
extractFilterValues(schema: Record<string, any>): Record<string, any>;
|
|
1168
1233
|
invokeOnPageSizeChange(pageSize: any): void;
|
|
1169
1234
|
invokeGoToPage(page: number): void;
|
|
1235
|
+
/** What an element does (action catalog) - for the template. */
|
|
1236
|
+
actionOf(option: any): string;
|
|
1170
1237
|
invokeOnCardHeader(element: any): void;
|
|
1171
1238
|
invokeOnCardFooter(element: any): void;
|
|
1172
|
-
/** Delete (asks first) and save
|
|
1239
|
+
/** Delete (asks first) and save (backend, or a browser list) go to the page's data; anything else to the app. */
|
|
1173
1240
|
invokeButtonClick(layout: any, record: any, recordIndex: any): Promise<void>;
|
|
1174
1241
|
/** The line above a refused record: "Not saved: <reason>" in the project's language (notSentReason, {reason}). */
|
|
1175
1242
|
sendErrorText(record: any): string;
|
|
@@ -1362,7 +1429,7 @@ declare function buttonLocked(option: any, state: LockState): boolean;
|
|
|
1362
1429
|
*/
|
|
1363
1430
|
declare function lockHint(option: any, reason: LockReason, translations?: Record<string, string> | null): string;
|
|
1364
1431
|
|
|
1365
|
-
declare class FormComponent implements OnInit, OnChanges, AfterViewInit, OnDestroy {
|
|
1432
|
+
declare class FormComponent implements OnInit, OnChanges, DoCheck, AfterViewInit, OnDestroy {
|
|
1366
1433
|
/** Marks for the app's test runner (#166): field key and button action. */
|
|
1367
1434
|
readonly vlFieldKey: typeof testFieldKey;
|
|
1368
1435
|
readonly vlFieldPath: typeof testFieldPath;
|
|
@@ -1475,6 +1542,8 @@ declare class FormComponent implements OnInit, OnChanges, AfterViewInit, OnDestr
|
|
|
1475
1542
|
*/
|
|
1476
1543
|
showMissing(form: NgForm | null): void;
|
|
1477
1544
|
invokeFormBtnClick(option: any, propertySchema: any): void;
|
|
1545
|
+
/** A change of the form may change the address of a dependent dropdown ({{form.x}} in its data_url). */
|
|
1546
|
+
ngDoCheck(): void;
|
|
1478
1547
|
setformData(): void;
|
|
1479
1548
|
setErroMessage(formField: any, errorMessages: any, field: any): string;
|
|
1480
1549
|
setValidations(): void;
|
|
@@ -1511,6 +1580,8 @@ declare class GridComponent implements AfterViewInit, OnDestroy {
|
|
|
1511
1580
|
readonly picker: DateTimePickerService;
|
|
1512
1581
|
private readonly host;
|
|
1513
1582
|
private readonly cdr;
|
|
1583
|
+
/** No further page to load - the list's end marks itself for tests (data-vl-list-end). */
|
|
1584
|
+
listEnd(): boolean;
|
|
1514
1585
|
/** Watches the element under the table; in view (with 250px ahead) it asks for the next page. */
|
|
1515
1586
|
private observeEnd;
|
|
1516
1587
|
ngOnDestroy(): void;
|
|
@@ -1728,6 +1799,10 @@ declare class GridComponent implements AfterViewInit, OnDestroy {
|
|
|
1728
1799
|
/** The DTO type of a column ("boolean" or a text flag for the switch). */
|
|
1729
1800
|
propertyType(col: any): string;
|
|
1730
1801
|
/** The DTO type of a column as the data object declares it ("string", "quantity" ...). */
|
|
1802
|
+
/** A column that shows a value calculated from fields of the row (innerAction calculate, older { action: multiply }). */
|
|
1803
|
+
isCalculated(col: any): boolean;
|
|
1804
|
+
/** The calculated value of a row: the operator over the named fields (multiply when none is named). */
|
|
1805
|
+
calculatedValue(col: any, row: any): number;
|
|
1731
1806
|
cellType(col: any): string;
|
|
1732
1807
|
static ɵfac: i0.ɵɵFactoryDeclaration<GridComponent, never>;
|
|
1733
1808
|
static ɵcmp: i0.ɵɵComponentDeclaration<GridComponent, "vl-grid", never, { "errorMessages": { "alias": "errorMessages"; "required": false; }; "environment": { "alias": "environment"; "required": false; }; "selectedLanguageInfo": { "alias": "selectedLanguageInfo"; "required": false; }; "tableitemInfo": { "alias": "tableitemInfo"; "required": false; }; "form": { "alias": "form"; "required": false; }; "isTableDataLoad": { "alias": "isTableDataLoad"; "required": false; }; "currenTableOptions": { "alias": "currenTableOptions"; "required": false; }; "projectSeleted": { "alias": "projectSeleted"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; "currentPage": { "alias": "currentPage"; "required": false; }; "pages": { "alias": "pages"; "required": false; }; "scrollPagination": { "alias": "scrollPagination"; "required": false; }; "userInfo": { "alias": "userInfo"; "required": false; }; "pageData": { "alias": "pageData"; "required": false; }; "design": { "alias": "design"; "required": false; }; }, { "editRow": "editRow"; "designChange": "designChange"; "onPageChange": "onPageChange"; "onPageSizeChange": "onPageSizeChange"; "onGridScroll": "onGridScroll"; "showGridLink": "showGridLink"; "gridButtonClick": "gridButtonClick"; "gridIncreamentClick": "gridIncreamentClick"; "gridDecreamentClick": "gridDecreamentClick"; "gridImgClick": "gridImgClick"; }, never, never, true, never>;
|
|
@@ -1834,6 +1909,7 @@ declare class ModelComponent implements OnChanges, OnDestroy {
|
|
|
1834
1909
|
private readonly dialogRef;
|
|
1835
1910
|
private readonly dialogConfig;
|
|
1836
1911
|
private utilityService;
|
|
1912
|
+
private readonly pdfViewer;
|
|
1837
1913
|
/** Marks for the app's test runner (#166): field key and button action. */
|
|
1838
1914
|
readonly vlFieldKey: typeof testFieldKey;
|
|
1839
1915
|
readonly vlFieldPath: typeof testFieldPath;
|
|
@@ -1921,6 +1997,8 @@ declare class ModelComponent implements OnChanges, OnDestroy {
|
|
|
1921
1997
|
private readonly lockHintCache;
|
|
1922
1998
|
/** A click on a locked button: nothing is sent; every field shows its message, the first missing one comes into view. */
|
|
1923
1999
|
showMissing(form: NgForm | null): void;
|
|
2000
|
+
/** A PDF button without an address in the record: nothing to show, the button stays away. */
|
|
2001
|
+
noPdf(formField: any): boolean;
|
|
1924
2002
|
checkValidty(form: NgForm): boolean;
|
|
1925
2003
|
onCancel(): void;
|
|
1926
2004
|
/** Whether the element's settings are open in the Designer (it is marked). */
|
|
@@ -1980,6 +2058,7 @@ interface TermsDialogDocument {
|
|
|
1980
2058
|
value: string;
|
|
1981
2059
|
}
|
|
1982
2060
|
declare class TermsDialog {
|
|
2061
|
+
private readonly pdfViewer;
|
|
1983
2062
|
/** the documents; to confirm, the terms (agb) come first, imprint and privacy as links */
|
|
1984
2063
|
set documents(docs: TermsDialogDocument[] | null);
|
|
1985
2064
|
/** true: Accept / Decline before the sign-in; false: a document to read */
|
|
@@ -2098,6 +2177,7 @@ declare class SideMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
|
2098
2177
|
private dialogService;
|
|
2099
2178
|
private notificationService;
|
|
2100
2179
|
private injector;
|
|
2180
|
+
private readonly pdfViewer;
|
|
2101
2181
|
isCollapsed: boolean;
|
|
2102
2182
|
isMobile: boolean;
|
|
2103
2183
|
projectsLayoutSchema: any;
|
|
@@ -2142,6 +2222,8 @@ declare class SideMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
|
2142
2222
|
designLogoutPath(): number[] | null;
|
|
2143
2223
|
/** "+": the Designer adds an entry at the top ([]) or into the folder of path */
|
|
2144
2224
|
designAdd(path: number[]): void;
|
|
2225
|
+
/** What a menu entry does (action catalog): '' opens its page; login, logout, cart. */
|
|
2226
|
+
menuAction(item: any): string;
|
|
2145
2227
|
menuText(item: any): string;
|
|
2146
2228
|
/** The inline menu's indent of a level, as nz-menu gives it in the app (24px per level). */
|
|
2147
2229
|
designIndent(parent: number[]): number;
|
|
@@ -2547,6 +2629,8 @@ declare function setToolkitKeyboardOnWeb(on: boolean): void;
|
|
|
2547
2629
|
declare function toolkitKeyboardActive(): boolean;
|
|
2548
2630
|
|
|
2549
2631
|
declare function setDateLanguage(languageCode: string | null | undefined): void;
|
|
2632
|
+
/** Display style iso (layout displayFormat): the date as 2026-10-30 and its time as 24 hours in every language. */
|
|
2633
|
+
declare function isIsoDate(option: any): boolean;
|
|
2550
2634
|
declare function currentDateLanguage(): string;
|
|
2551
2635
|
/** The numeric date pattern of a language in PrimeNG letters, year with four digits: de "dd.mm.yy". */
|
|
2552
2636
|
declare function languageDatePattern(languageCode?: string): string;
|
|
@@ -2643,6 +2727,52 @@ declare class DateTextPipe implements PipeTransform {
|
|
|
2643
2727
|
static ɵpipe: i0.ɵɵPipeDeclaration<DateTextPipe, "vlDateText", true>;
|
|
2644
2728
|
}
|
|
2645
2729
|
|
|
2730
|
+
/** What to show: an address (http, data:, blob:), a title, the call's option (proxy), the app's texts. */
|
|
2731
|
+
interface PdfSource {
|
|
2732
|
+
url: string;
|
|
2733
|
+
title?: string;
|
|
2734
|
+
option?: any;
|
|
2735
|
+
translations?: Record<string, string> | null;
|
|
2736
|
+
}
|
|
2737
|
+
/** The bytes of a base64 text. */
|
|
2738
|
+
declare function bytesOfBase64(text: string): Uint8Array;
|
|
2739
|
+
/** The next zoom step, within the limits. */
|
|
2740
|
+
declare function nextZoom(zoom: number, step: number): number;
|
|
2741
|
+
declare class PdfViewerComponent implements OnInit, OnDestroy {
|
|
2742
|
+
source: PdfSource;
|
|
2743
|
+
private area?;
|
|
2744
|
+
/** set by the service: takes the layer away */
|
|
2745
|
+
closed: () => void;
|
|
2746
|
+
readonly pages: i0.WritableSignal<number[]>;
|
|
2747
|
+
readonly problem: i0.WritableSignal<boolean>;
|
|
2748
|
+
private doc;
|
|
2749
|
+
private zoom;
|
|
2750
|
+
private observer;
|
|
2751
|
+
private drawn;
|
|
2752
|
+
ngOnInit(): Promise<void>;
|
|
2753
|
+
ngOnDestroy(): void;
|
|
2754
|
+
t(key: string, english: string): string;
|
|
2755
|
+
close(): void;
|
|
2756
|
+
onEscape(): void;
|
|
2757
|
+
zoomBy(step: number): void;
|
|
2758
|
+
private canvases;
|
|
2759
|
+
/** Every page gets a size at once (the scroll bar is right), its content when it comes into view. */
|
|
2760
|
+
private prepare;
|
|
2761
|
+
/** The page as wide as the area, times the zoom. */
|
|
2762
|
+
private sizeOf;
|
|
2763
|
+
private draw;
|
|
2764
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<PdfViewerComponent, never>;
|
|
2765
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<PdfViewerComponent, "vl-pdf-viewer", never, { "source": { "alias": "source"; "required": false; }; }, {}, never, never, true, never>;
|
|
2766
|
+
}
|
|
2767
|
+
/** Opens a PDF inside the app. */
|
|
2768
|
+
declare class PdfViewerService {
|
|
2769
|
+
private readonly app;
|
|
2770
|
+
private readonly injector;
|
|
2771
|
+
open(source: PdfSource): void;
|
|
2772
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<PdfViewerService, never>;
|
|
2773
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<PdfViewerService>;
|
|
2774
|
+
}
|
|
2775
|
+
|
|
2646
2776
|
/** [src]="source | vlMedia | async" - the same Promise for the same source, so no request loop. */
|
|
2647
2777
|
declare class MediaSourcePipe implements PipeTransform {
|
|
2648
2778
|
private couchdb;
|
|
@@ -2819,11 +2949,20 @@ declare function checkTransformResult(name: string, result: unknown, limits: Add
|
|
|
2819
2949
|
records?: any[];
|
|
2820
2950
|
problem?: string;
|
|
2821
2951
|
};
|
|
2822
|
-
/**
|
|
2952
|
+
/**
|
|
2953
|
+
* The route of an address: its path against addon.json routes, the longest declared path first, so "/a/b" can have
|
|
2954
|
+
* its own handler beside "/a". The query is the handler's. An address with a host is never a route.
|
|
2955
|
+
*/
|
|
2956
|
+
declare function routeOf(url: string, routes: Record<string, any> | undefined): {
|
|
2957
|
+
route: string;
|
|
2958
|
+
query: Record<string, string>;
|
|
2959
|
+
} | null;
|
|
2960
|
+
/** What a route gave back, checked: { items, total, notice } or a list; else the reason. notice: a hint for the user. */
|
|
2823
2961
|
declare function checkRouteResult(path: string, result: any, limits: AddonLimits): {
|
|
2824
2962
|
answer?: {
|
|
2825
2963
|
items: any[];
|
|
2826
2964
|
total: number;
|
|
2965
|
+
notice?: string;
|
|
2827
2966
|
};
|
|
2828
2967
|
problem?: string;
|
|
2829
2968
|
};
|
|
@@ -2846,6 +2985,7 @@ declare class AddonHostService {
|
|
|
2846
2985
|
private readonly urls;
|
|
2847
2986
|
private readonly calls;
|
|
2848
2987
|
private seq;
|
|
2988
|
+
private routes;
|
|
2849
2989
|
private upstreamLeft;
|
|
2850
2990
|
/**
|
|
2851
2991
|
* The project whose add-on runs (its database, "<tenant>_<project>"), and the values a host "{{name}}" of
|
|
@@ -2856,10 +2996,19 @@ declare class AddonHostService {
|
|
|
2856
2996
|
setValues(values: Record<string, any>): void;
|
|
2857
2997
|
/** Records through the add-on's transform (addon.json transforms.<name>): records in, records out. */
|
|
2858
2998
|
transform(name: string, records: any[], params?: Record<string, any>): Promise<any[]>;
|
|
2999
|
+
/**
|
|
3000
|
+
* The add-on's answer for an address of addon.json routes, null when no route means it: the page then loads from
|
|
3001
|
+
* its backend. page: the runtime's page number, from 0 - the add-on counts from 1. In the shape of a backend page
|
|
3002
|
+
* (totalElements, size), so the page reads it like any other answer.
|
|
3003
|
+
*/
|
|
3004
|
+
answerFor(url: string, pageNumber?: number, size?: number): Promise<any | null>;
|
|
3005
|
+
/** The routes of addon.json, read once per project; an app without add-on has none. */
|
|
3006
|
+
private routeTable;
|
|
2859
3007
|
/** Data of the add-on's route (addon.json routes, GET): { items, total }. */
|
|
2860
3008
|
route(path: string, query: Record<string, any>, page?: number, size?: number): Promise<{
|
|
2861
3009
|
items: any[];
|
|
2862
3010
|
total: number;
|
|
3011
|
+
notice?: string;
|
|
2863
3012
|
}>;
|
|
2864
3013
|
private prepare;
|
|
2865
3014
|
/** addon.json and the add-on's code files from the project, linked from the entry file on. */
|
|
@@ -3193,6 +3342,8 @@ declare class DateTimeControl {
|
|
|
3193
3342
|
private control?;
|
|
3194
3343
|
/** PrimeNG pattern of the date part (de dd.mm.yy = dd.mm.yyyy) */
|
|
3195
3344
|
pattern(): string;
|
|
3345
|
+
/** Display style iso: the date as 2026-10-30 in every language (a test types year, month, day - data-vl-date-iso) */
|
|
3346
|
+
isIso(): boolean;
|
|
3196
3347
|
/** "12" (en, AM/PM) or "24" - by the app language */
|
|
3197
3348
|
hourFormat(): '12' | '24';
|
|
3198
3349
|
placeholder(): string;
|
|
@@ -3248,6 +3399,7 @@ type MediaKind = 'image' | 'video' | 'audio' | 'pdf' | 'file';
|
|
|
3248
3399
|
declare function mediaKind(source: string, ...names: any[]): MediaKind;
|
|
3249
3400
|
declare class MediaControl {
|
|
3250
3401
|
private readonly sanitizer;
|
|
3402
|
+
readonly pdfViewer: PdfViewerService;
|
|
3251
3403
|
private trustedCache;
|
|
3252
3404
|
field: any;
|
|
3253
3405
|
/** the field's value: a URL, a file name of the project's Media/, or a data: URL */
|
|
@@ -3282,6 +3434,8 @@ declare function controlProperty(field: any, propertySchema: any): any;
|
|
|
3282
3434
|
* - otherwise the control (option.control, or the field catalog's choice for the type)
|
|
3283
3435
|
*/
|
|
3284
3436
|
declare function controlKind(field: any, property: any): ControlKind;
|
|
3437
|
+
/** The wrapper of a field keeps the layout's style; a button's look stays on the button, not around it too. */
|
|
3438
|
+
declare function wrapperStyleOf(field: any, style: Record<string, any>): Record<string, any>;
|
|
3285
3439
|
/**
|
|
3286
3440
|
* A style object of the layout split into its classes and its CSS: { classes: ['a', 'b'], color }
|
|
3287
3441
|
* -> { classes: 'a b', style: { color } }. Every class counts, not only the first.
|
|
@@ -3370,6 +3524,12 @@ declare class ControlComponent implements OnChanges {
|
|
|
3370
3524
|
/** the property's name in a record ("fromDate") */
|
|
3371
3525
|
name: string;
|
|
3372
3526
|
ngOnChanges(): void;
|
|
3527
|
+
/**
|
|
3528
|
+
* The values the text input shows. A locked field still holding its fixed start text (option.fieldData.default, e.g.
|
|
3529
|
+
* "FREE") shows that text in the language of the app when the language has it (de "FREI") - only shown: what the
|
|
3530
|
+
* form sends stays the stored value (luv2shop's Shipping on the checkout, 2026-11-02).
|
|
3531
|
+
*/
|
|
3532
|
+
private shownSchema;
|
|
3373
3533
|
get display(): boolean;
|
|
3374
3534
|
/** a list: the value is shown, not typed in (protected in a form is a locked input, see ruleField) */
|
|
3375
3535
|
get readonly(): boolean;
|
|
@@ -3558,5 +3718,5 @@ declare class DesignTextPipe implements PipeTransform {
|
|
|
3558
3718
|
static ɵpipe: i0.ɵɵPipeDeclaration<DesignTextPipe, "vlDesignText", true>;
|
|
3559
3719
|
}
|
|
3560
3720
|
|
|
3561
|
-
export { ADDON_API_VERSION, ADDON_TEST_KIT, AddonHostService, AppVersionResetService, Autocomplete, BACKEND_PROXY_PREFIX, BackendCallService, CardComponent, CardDesigner, CheckboxControl, ConfigService, ControlComponent, Couchdb, CustomKeyboardComponent, CustomKeyboardDirective, CustomKeyboardService, DATA_KEY_ANSWER, DATA_KEY_NONE, DEFAULT_DATE_FORMAT, DESIGN_TEXTS, DateFormatPipe, DateHintPipe, DateRangeControl, DateTextPipe, DateTimeControl, DesignBarComponent, DesignFieldPipe, DesignTextPipe, DropMarkerComponent, DropdownControl, FormComponent, GRID_COLUMNS, GridComponent, HeaderMenuComponent, LogsComponent, MAX_FIELDS_PER_ROW, MAX_ROW_COLUMNS, MediaControl, MediaSourcePipe, MobileKeycloakService, MobileOidcService, MobileOktaService, ModelComponent, NetworkLogService, NotificationService, NumberControl, PLACEHOLDER_SOURCES, PageData, PaginationComponent, PasswordControl, PlaceholderPipe, READ_ATTEMPT_TIMEOUT, REQUEST_STAGES, RETRY_PAUSES, RETRY_STATUSES, RadioControl, RecordStore, RemoteListService, RequestService, RequestTimeoutError, RequestTimeoutService, RulesPipe, SEND_ERROR_KEY, SIDE_DOCK_CLASS, STORAGE_DATE_FORMAT, SectionDesigner, SideMenuComponent, SwitchControl, TermsDialog, TextareaControl, Textbox, UtilityService, ViewToolkitModule, VisiblePipe, acceptedLocally, addButton, addCardButton, addSection, addonHostAllowed, addonImports, addonLimits, addonManifestProblem, applyLayoutDefaults, backendTermsState, backendUrl, blankComments, buildBackendCall, buttonLocked, cardButton, checkRouteResult, checkTransformResult, clearHeader, cloneLayout, columnFromProperty, controlKind, controlProperty, currencyDigits, currentDateLanguage, dateDigitCount, dateInputPattern, designDropIds, designField, designText, designTexts, displayDateValue, displayNumber, dropCardProperty, dropGridProperty, dropObjectName, dropProperty, dropTypeAt, elementFromProperty, fieldFromProperty, fieldInnerLayoutStyle, fieldModel, fieldRules, fieldSpan, fillFromUser, fillPlaceholders, fixedTimeText, formatDate, formatDates, fromStorageValue, gridColumnCount, hasBackendCall, headerButton, inputFormatHint, insertField, isAddonCode, isAddonTestFile, isBrowserSource, isNativeMobile, isNativePhone, isPropertyDrop, isSignedIn, isTarget, languageDatePattern, layoutPlaceholder, linkAddonModules, lockHint, lockReason, lockReasons, mediaKind, moveCardElement, moveColumn, moveField, moveSection, moveTreeNode, newButton, newSection, normalizeCard, normalizeCustomKeyboardType, normalizeSections, numberShape, numberStep, numberSuffix, parseRecords, parseStorageDate, parseTimeText, primeDatePattern, proxyFor, rebalanceRow, recordOf, recordsFrom, removeCardElement, removeColumn, removeField, removeHeaderElement, removeSection, removeTreeNode, replaceCardElement, replaceColumn, replaceField, replaceSection, replaceTreeNode, requestDesignDelete, resizeColumn, resolveAddonPath, resolveCustomKeyboardType, resolvePlaceholder, resolveTemplate, ruleMessage, runAddonTests, sampleRecords, sampleValue, sectionSpan, sectionSticky, sectionTabletSpan, sectionVisible, sendErrorText, sendsForm, setDateLanguage, setInputHintLanguage, setProxyEnvironment, setToolkitKeyboardOnWeb, shapeDateDigits, shapeTimeText, sideDockWidth, splitReference, stagedRead, stagedRequest, storageKind, storageValue, storedToTyped, styleParts, termsStamp, termsStorageKey, termsToConfirm, termsUrl, termsUser, testAction, testFieldKey, testFieldPath, testWrites, timeHourFormat, toggleMeridiem, toolkitKeyboardActive, transformHandler, treeNode, treePaths, typedMeridiem, typedToStored, usesTwelveHours, validTreePath, visibleFields, whenOnline, withAppPagination, withoutMarks };
|
|
3562
|
-
export type { AddonFiles, AddonLimits, AddonManifest, AddonTestResult, BackendCall, CallContext, CardDesignerHost, CardDragData, CardDropSpot, CardDropType, CardPlace, ControlKind, CustomKeyboardTarget, CustomKeyboardType, DataSource, DesignAction, DesignDeleteRequest, DesignDevice, DesignEvent, DesignPropertyDrop, DesignTarget, DesignTexts, DesignTranslations, DropSpot, DropType, FieldKind, FieldModel, FieldRules, LockHint, LockReason, LockState, MediaKind, MobileAuthTokens, MobileOktaRefresh, MobileOktaTokens, NumberShape, OidcProvider, OidcRefresh, OidcTokens, PageDataDeps, RequestTimeoutMessages, SectionDesignerHost, SectionDragData, SectionKind, SendResult, StagedReadOptions, StorageKind, TermsAcceptance, TermsDialogDocument, TermsSettings, TreeKey, VlDesign };
|
|
3721
|
+
export { ADDON_API_VERSION, ADDON_TEST_KIT, AddonHostService, AppVersionResetService, Autocomplete, BACKEND_PROXY_PREFIX, BackendCallService, CardComponent, CardDesigner, CheckboxControl, ConfigService, ControlComponent, Couchdb, CustomKeyboardComponent, CustomKeyboardDirective, CustomKeyboardService, DATA_KEY_ANSWER, DATA_KEY_NONE, DEFAULT_DATE_FORMAT, DESIGN_TEXTS, DateFormatPipe, DateHintPipe, DateRangeControl, DateTextPipe, DateTimeControl, DesignBarComponent, DesignFieldPipe, DesignTextPipe, DropMarkerComponent, DropdownControl, FormComponent, GRID_COLUMNS, GridComponent, HeaderMenuComponent, LogsComponent, MAX_FIELDS_PER_ROW, MAX_ROW_COLUMNS, MediaControl, MediaSourcePipe, MobileKeycloakService, MobileOidcService, MobileOktaService, ModelComponent, NetworkLogService, NotificationService, NumberControl, PLACEHOLDER_SOURCES, PageData, PaginationComponent, PasswordControl, PdfViewerComponent, PdfViewerService, PlaceholderPipe, READ_ATTEMPT_TIMEOUT, REQUEST_STAGES, RETRY_PAUSES, RETRY_STATUSES, RadioControl, RecordStore, RemoteListService, RequestService, RequestTimeoutError, RequestTimeoutService, RulesPipe, SEND_ERROR_KEY, SIDE_DOCK_CLASS, STORAGE_DATE_FORMAT, SectionDesigner, SideMenuComponent, SwitchControl, TermsDialog, TextareaControl, Textbox, UtilityService, ViewToolkitModule, VisiblePipe, acceptedLocally, addButton, addCardButton, addSection, addonHostAllowed, addonImports, addonLimits, addonManifestProblem, applyLayoutDefaults, backendTermsState, backendUrl, blankComments, buildBackendCall, buttonLocked, bytesOfBase64, cardButton, checkRouteResult, checkTransformResult, clearHeader, cloneLayout, columnFromProperty, controlKind, controlProperty, currencyDigits, currentDateLanguage, dateDigitCount, dateInputPattern, dependsOnForm, designDropIds, designField, designText, designTexts, displayDateValue, displayNumber, dropCardProperty, dropGridProperty, dropObjectName, dropProperty, dropTypeAt, elementFromProperty, fieldFromProperty, fieldInnerLayoutStyle, fieldModel, fieldRules, fieldSpan, fillFromUser, fillPlaceholders, fixedTimeText, formValuesGiven, formatDate, formatDates, fromStorageValue, gridColumnCount, hasBackendCall, headerButton, inputFormatHint, insertField, isAddonCode, isAddonTestFile, isBrowserSource, isIsoDate, isNativeMobile, isNativePhone, isPropertyDrop, isSignedIn, isTarget, languageDatePattern, layoutPlaceholder, linkAddonModules, linkOfRecord, lockHint, lockReason, lockReasons, mediaKind, moveCardElement, moveColumn, moveField, moveSection, moveTreeNode, newButton, newSection, nextZoom, normalizeCard, normalizeCustomKeyboardType, normalizeSections, numberShape, numberStep, numberSuffix, parseRecords, parseStorageDate, parseTimeText, primeDatePattern, proxyFor, rebalanceRow, recordOf, recordsFrom, removeCardElement, removeColumn, removeField, removeHeaderElement, removeSection, removeTreeNode, replaceCardElement, replaceColumn, replaceField, replaceSection, replaceTreeNode, requestDesignDelete, resizeColumn, resolveAddonPath, resolveCustomKeyboardType, resolvePlaceholder, resolveTemplate, routeOf, ruleMessage, runAddonTests, sampleRecords, sampleValue, sectionSpan, sectionSticky, sectionTabletSpan, sectionVisible, sendErrorText, sendsForm, setDateLanguage, setInputHintLanguage, setProxyEnvironment, setToolkitKeyboardOnWeb, shapeDateDigits, shapeTimeText, sideDockWidth, splitReference, stagedRead, stagedRequest, storageKind, storageValue, storedToTyped, styleParts, termsStamp, termsStorageKey, termsToConfirm, termsUrl, termsUser, testAction, testFieldKey, testFieldPath, testWrites, timeHourFormat, toggleMeridiem, toggleRecord, toolkitKeyboardActive, transformHandler, treeNode, treePaths, typedMeridiem, typedToStored, usesTwelveHours, validTreePath, visibleFields, whenOnline, withAppPagination, withoutMarks, wrapperStyleOf };
|
|
3722
|
+
export type { AddonFiles, AddonLimits, AddonManifest, AddonTestResult, BackendCall, CallContext, CardDesignerHost, CardDragData, CardDropSpot, CardDropType, CardPlace, ControlKind, CustomKeyboardTarget, CustomKeyboardType, DataSource, DesignAction, DesignDeleteRequest, DesignDevice, DesignEvent, DesignPropertyDrop, DesignTarget, DesignTexts, DesignTranslations, DropSpot, DropType, FieldKind, FieldModel, FieldRules, LockHint, LockReason, LockState, MediaKind, MobileAuthTokens, MobileOktaRefresh, MobileOktaTokens, NumberShape, OidcProvider, OidcRefresh, OidcTokens, PageDataDeps, PdfSource, RequestTimeoutMessages, SectionDesignerHost, SectionDragData, SectionKind, SendResult, StagedReadOptions, StorageKind, TermsAcceptance, TermsDialogDocument, TermsSettings, TreeKey, VlDesign };
|