@yomotech/view-toolkit 1.0.47 → 1.0.52
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 +948 -10
- package/fesm2022/yomotech-view-toolkit-catalog.mjs.map +1 -1
- package/fesm2022/yomotech-view-toolkit.mjs +1948 -846
- package/fesm2022/yomotech-view-toolkit.mjs.map +1 -1
- package/package.json +1 -1
- package/types/yomotech-view-toolkit-catalog.d.ts +361 -7
- package/types/yomotech-view-toolkit.d.ts +442 -32
|
@@ -10,8 +10,10 @@ import { NzModalService } from 'ng-zorro-antd/modal';
|
|
|
10
10
|
import { ToastrService } from 'ngx-toastr';
|
|
11
11
|
import { NgForm } from '@angular/forms';
|
|
12
12
|
import { OktaAuthStateService } from '@okta/okta-angular';
|
|
13
|
+
import * as _yomotech_view_toolkit from '@yomotech/view-toolkit';
|
|
13
14
|
import { DynamicDialogRef, DynamicDialogConfig, DialogService } from 'primeng/dynamicdialog';
|
|
14
15
|
import { NzI18nService } from 'ng-zorro-antd/i18n';
|
|
16
|
+
import { CardLayout } from '@yomotech/view-toolkit/catalog';
|
|
15
17
|
import * as catalog from '@yomotech/view-toolkit/catalog';
|
|
16
18
|
export { catalog as FieldCatalog };
|
|
17
19
|
import { SafeResourceUrl } from '@angular/platform-browser';
|
|
@@ -70,9 +72,9 @@ declare function fieldRules(field: any): FieldRules;
|
|
|
70
72
|
*/
|
|
71
73
|
declare function ruleMessage(field: any, errors: Record<string, any> | null | undefined, projectTexts?: Record<string, string> | null, translations?: Record<string, string> | null, caption?: string): string;
|
|
72
74
|
/**
|
|
73
|
-
* The grid of label and field: layout "horizontal" puts the label beside the field (dialog:
|
|
74
|
-
* column, form: 30% with at least
|
|
75
|
-
* dialog.
|
|
75
|
+
* The grid of label and field: layout "horizontal" puts the label beside the field (dialog: a 5rem
|
|
76
|
+
* column, form: 30% with at least 7rem - rem grows with the font), otherwise above it. The layout's
|
|
77
|
+
* layoutStyle wins in dialog and form. A narrow form section or dialog puts the label above (their CSS).
|
|
76
78
|
*/
|
|
77
79
|
declare function fieldInnerLayoutStyle(formField: any, container?: 'dialog' | 'form'): Record<string, any>;
|
|
78
80
|
/**
|
|
@@ -99,6 +101,12 @@ type DesignDevice = 'desktop' | 'tablet' | 'mobile';
|
|
|
99
101
|
interface VlDesign {
|
|
100
102
|
/** the element whose settings are open in the Designer - shown marked */
|
|
101
103
|
selected?: DesignTarget | null;
|
|
104
|
+
/** The application's selected-language texts, NOT the editor/handle language. Display only. */
|
|
105
|
+
translations?: Readonly<Record<string, string>>;
|
|
106
|
+
/** Project language codes used to preview the automatically generated setting entries, without fetching. */
|
|
107
|
+
languages?: string[];
|
|
108
|
+
/** Editor-resolved Media sources; design mode never fetches project images or auth data. */
|
|
109
|
+
media?: Readonly<Record<string, string>>;
|
|
102
110
|
/** the device the page is shown on; the containers that choose by the window (card columns) follow it */
|
|
103
111
|
device?: DesignDevice;
|
|
104
112
|
/** texts of the design handles in the Designer's language; English for every text not given */
|
|
@@ -117,7 +125,11 @@ interface DesignTarget {
|
|
|
117
125
|
* element: a card element, parentIndex the horizontal layout holding it; header / headerElement: the card's
|
|
118
126
|
* header and one of its buttons; column: a grid column
|
|
119
127
|
*/
|
|
120
|
-
kind: 'container' | 'section' | 'field' | 'element' | 'header' | 'headerElement' | 'column';
|
|
128
|
+
kind: 'container' | 'section' | 'field' | 'element' | 'header' | 'headerElement' | 'column' | 'menuEntry';
|
|
129
|
+
/** Index path of a nested header/group or side-menu entry. */
|
|
130
|
+
path?: number[];
|
|
131
|
+
/** Generated setting entries are visible/selectable but are edited through Main appSettings, not the menu array. */
|
|
132
|
+
generated?: boolean;
|
|
121
133
|
sectionIndex?: number;
|
|
122
134
|
fieldIndex?: number;
|
|
123
135
|
index?: number;
|
|
@@ -126,9 +138,22 @@ interface DesignTarget {
|
|
|
126
138
|
part?: 'input';
|
|
127
139
|
}
|
|
128
140
|
/** What a container in design mode tells the Designer. */
|
|
129
|
-
|
|
141
|
+
/** Emitted before mutation. The editor calls askAndDelete and passes remove as its confirmed action.
|
|
142
|
+
* Cancelling (or not handling the event) changes nothing. remove returns false for a stale/already-used request. */
|
|
143
|
+
interface DesignDeleteRequest {
|
|
144
|
+
type: 'deleteRequested';
|
|
145
|
+
target: DesignTarget;
|
|
146
|
+
name: string;
|
|
147
|
+
remove: () => boolean;
|
|
148
|
+
}
|
|
149
|
+
type DesignEvent = DesignDeleteRequest
|
|
150
|
+
/** "+" was pressed: the Designer adds an element there (its dialog) - a menu entry at the top or into a folder */
|
|
151
|
+
| {
|
|
152
|
+
type: 'add';
|
|
153
|
+
target: DesignTarget;
|
|
154
|
+
}
|
|
130
155
|
/** an element was chosen: the Designer opens its settings */
|
|
131
|
-
{
|
|
156
|
+
| {
|
|
132
157
|
type: 'select';
|
|
133
158
|
target: DesignTarget;
|
|
134
159
|
}
|
|
@@ -199,6 +224,10 @@ interface DesignTexts {
|
|
|
199
224
|
editGrid: string;
|
|
200
225
|
emptyGrid: string;
|
|
201
226
|
button: string;
|
|
227
|
+
addMenuEntry: string;
|
|
228
|
+
userName: string;
|
|
229
|
+
addMenuChild: string;
|
|
230
|
+
emptyHeader: string;
|
|
202
231
|
}
|
|
203
232
|
declare const DESIGN_TEXTS: DesignTexts;
|
|
204
233
|
/** The design texts with the Designer's own over the English ones. */
|
|
@@ -213,6 +242,8 @@ declare function dropObjectName(drop: DesignPropertyDrop): string;
|
|
|
213
242
|
declare function cloneLayout<T>(value: T): T;
|
|
214
243
|
/** The ids of every drop list of the containers in design mode on the page (the Designer's data objects drop on them). */
|
|
215
244
|
declare function designDropIds(): string[];
|
|
245
|
+
/** Only a host-confirmed call can remove a saved item. Double confirmation and stale targets are ignored. */
|
|
246
|
+
declare function requestDesignDelete(emit: (event: DesignEvent) => void, target: DesignTarget, name: string, remove: () => void, current?: () => boolean): void;
|
|
216
247
|
|
|
217
248
|
type CardDropType = 'before' | 'after' | 'left' | 'right' | 'empty';
|
|
218
249
|
/** Where a dragged element lands: at a card element (index), or inside the horizontal layout parentIndex at innerIndex. */
|
|
@@ -229,6 +260,15 @@ interface CardPlace {
|
|
|
229
260
|
index: number;
|
|
230
261
|
parentIndex: number | null;
|
|
231
262
|
}
|
|
263
|
+
/** How many columns a grid-template-columns names: "repeat(3, 34px)" three, "minmax(0, 1fr) repeat(3, 34px)" four. */
|
|
264
|
+
declare function gridColumnCount(template: unknown): number;
|
|
265
|
+
/**
|
|
266
|
+
* A horizontal layout draws its elements in equal columns - unless its columns already fit its elements: widths
|
|
267
|
+
* set for them ("minmax(0, 1fr) repeat(3, 34px)": the order number wide, three narrow buttons) stay. Every edit of the
|
|
268
|
+
* card set them back to equal columns, which squeezed tm's order number (2026-10-28).
|
|
269
|
+
*/
|
|
270
|
+
/** The most equal columns a row of a card gets; more elements wrap to the next line. */
|
|
271
|
+
declare const MAX_ROW_COLUMNS = 4;
|
|
232
272
|
/**
|
|
233
273
|
* The card layout as the Designer keeps it, changed in place: no empty classes on the card styles, the card's
|
|
234
274
|
* columns are drawn by the container (no gridTemplateColumns in its style), no classes on the elements (the right
|
|
@@ -260,6 +300,7 @@ interface CardDesignerHost {
|
|
|
260
300
|
deselect(): void;
|
|
261
301
|
/** the view is drawn again (the apps run without zone.js: a change after a timer is not seen otherwise) */
|
|
262
302
|
refresh(): void;
|
|
303
|
+
requestDelete(target: DesignTarget, name: string, remove: () => void, current: () => boolean): void;
|
|
263
304
|
}
|
|
264
305
|
/** The data an element carries while it is dragged inside the card. */
|
|
265
306
|
interface CardDragData {
|
|
@@ -421,8 +462,20 @@ declare class UtilityService {
|
|
|
421
462
|
private getSecureItem;
|
|
422
463
|
getLocalStorage<T = unknown>(key: string): Promise<any>;
|
|
423
464
|
showAllProjects(): Promise<void>;
|
|
465
|
+
/**
|
|
466
|
+
* The form's values as the body of a POST - a copy, nothing evaluated. It ran every {{…}} in the values as
|
|
467
|
+
* JavaScript (new Function): whatever a person typed into a field or a page held was executed in the app
|
|
468
|
+
* (OFFENE-PUNKTE 95). The content a backend wants comes from option.body with the safe placeholders
|
|
469
|
+
* ({{form.x}}, {{record.x}}, {{userInfo.x}}, {{cart.x}}, {{env.x}} - resolveTemplate).
|
|
470
|
+
*/
|
|
424
471
|
parseBodyObject(obj: any): any;
|
|
425
|
-
|
|
472
|
+
/**
|
|
473
|
+
* The cart's sum: each item's price field × its quantity. The price field is the cart's option.priceField, set in
|
|
474
|
+
* the Designer (header → Cart) - the library knows no field name (it was unitPrice, OFFENE-PUNKTE 116 A).
|
|
475
|
+
*/
|
|
476
|
+
getTotalPrice(tableitemInfo: any, priceField?: string): number;
|
|
477
|
+
/** A field's start value from the cart: {{cart.quantity}} / {{cart.totalPrice}} - older {{quantity}} / {{totalPrice}} too. */
|
|
478
|
+
cartValue(text: any, cartInfo: any): any;
|
|
426
479
|
getTotalQuantity(tableitemInfo: any): number;
|
|
427
480
|
/**
|
|
428
481
|
* A page's address with its placeholders: {{pageNumber}}, {{pageSize}} and - with a context - any field of the
|
|
@@ -529,6 +582,11 @@ declare class Couchdb {
|
|
|
529
582
|
* classifying it as text would change the shape they receive.
|
|
530
583
|
*/
|
|
531
584
|
private isTextFile;
|
|
585
|
+
/**
|
|
586
|
+
* A text file of the project as text, also when it is stored as an attachment - an add-on's source
|
|
587
|
+
* (addon/<name>.js, OFFENE-PUNKTE 92). Null when it is not there.
|
|
588
|
+
*/
|
|
589
|
+
getTextFile(dbName: string, docId: string): Promise<string | null>;
|
|
532
590
|
/** Ids of the files under a folder of the project, e.g. listFiles(db, 'ssl/mobile/'). Empty on any error. */
|
|
533
591
|
listFiles(dbName: string, prefix: string): Promise<string[]>;
|
|
534
592
|
private getDocumentUrl;
|
|
@@ -683,6 +741,15 @@ declare class CustomKeyboardService {
|
|
|
683
741
|
* in custom-keyboard.component.css (#166, OFFENE-PUNKTE 43).
|
|
684
742
|
*/
|
|
685
743
|
private markActiveField;
|
|
744
|
+
/**
|
|
745
|
+
* The key at the bottom right the field asks for (Designer: option.enterKey, data-vl-enter-key on the field or
|
|
746
|
+
* around it): done (default), search, next.
|
|
747
|
+
*/
|
|
748
|
+
enterKey(): 'done' | 'search' | 'next';
|
|
749
|
+
/** Search: the field gets Enter (keydown, keyup - as a device's Search key sends it), its action runs, then the keyboard closes. */
|
|
750
|
+
submit(): void;
|
|
751
|
+
/** Next: on to the next field that can be typed in (same form or dialog, in reading order); none - the keyboard closes. */
|
|
752
|
+
next(): void;
|
|
686
753
|
close(option?: {
|
|
687
754
|
blurTarget?: boolean;
|
|
688
755
|
restoreAccessoryBar?: boolean;
|
|
@@ -804,7 +871,9 @@ declare class DateTimePickerService {
|
|
|
804
871
|
* so paging through months with five and six weeks does not change its height either.
|
|
805
872
|
*/
|
|
806
873
|
private fitToKeyboardHeight;
|
|
807
|
-
/**
|
|
874
|
+
/** The time part of a date-and-time calendar with its gap above, 0 without one. */
|
|
875
|
+
private timePartHeight;
|
|
876
|
+
/** Day cells as large as the panel's height allows for its header, the weekdays, six weeks and a time part. */
|
|
808
877
|
private fitDays;
|
|
809
878
|
/**
|
|
810
879
|
* The time picker hangs below its field - upright there is room. Where there is not (a phone in
|
|
@@ -838,6 +907,8 @@ interface DataSource {
|
|
|
838
907
|
/** older Designer versions: localStorage: true / sessionStorage: true instead of storageType */
|
|
839
908
|
localStorage?: boolean;
|
|
840
909
|
sessionStorage?: boolean;
|
|
910
|
+
/** with storageType database: the page starts empty and loads once every filter field has a value */
|
|
911
|
+
loadOnFilter?: boolean;
|
|
841
912
|
}
|
|
842
913
|
type StorageKind = 'localstorage' | 'sessionstorage' | 'filter' | 'database' | '';
|
|
843
914
|
/** The kind of a data source, lowercase - "localStorage" of older Designer versions counts as "localstorage". */
|
|
@@ -878,13 +949,30 @@ interface PageDataDeps {
|
|
|
878
949
|
sendBackend(option: any, records: any[], extra: any): Promise<any>;
|
|
879
950
|
/** The question before deleting; true = delete. */
|
|
880
951
|
confirmDelete(button: any): Promise<boolean>;
|
|
881
|
-
/** A message to the user, by text key (saveFailed, deleteFailed, loadFailed)
|
|
882
|
-
|
|
952
|
+
/** A message to the user, by text key (saveFailed, deleteFailed, loadFailed); text: the page's / button's own
|
|
953
|
+
* errorMessage, shown instead of the key's text when set. */
|
|
954
|
+
failed(key: string, error: unknown, text?: string): void;
|
|
955
|
+
/** After sending: how many records the backend took and how many it refused; option: the button (its
|
|
956
|
+
* successMessage) (optional). */
|
|
957
|
+
sent?(result: SendResult, option?: any): void;
|
|
958
|
+
/** A hint to the user, e.g. the page's emptyMessage when a backend load found nothing (optional). */
|
|
959
|
+
notice?(text: string): void;
|
|
883
960
|
/** Dates of browser records back to Date objects (optional). */
|
|
884
961
|
restoreDates?(records: any[]): any[];
|
|
885
962
|
/** The app's own work on records just loaded from the backend, e.g. pictures from Media (optional). */
|
|
886
963
|
prepare?(records: any[]): Promise<any[]>;
|
|
887
964
|
}
|
|
965
|
+
/** What a send did: records the backend took, records it refused (they stay, marked). */
|
|
966
|
+
interface SendResult {
|
|
967
|
+
sent: number;
|
|
968
|
+
failed: number;
|
|
969
|
+
}
|
|
970
|
+
/** The mark of a waiting record the backend refused: { message, at } - stored with it, shown on its card. */
|
|
971
|
+
declare const SEND_ERROR_KEY = "_vlSendError";
|
|
972
|
+
/** A record as it goes to the backend: without the library's own marks (_vl...). */
|
|
973
|
+
declare function withoutMarks(record: any): any;
|
|
974
|
+
/** The reason of a refused call as a short text. */
|
|
975
|
+
declare function sendErrorText(error: unknown): string;
|
|
888
976
|
declare class PageData {
|
|
889
977
|
records: any[];
|
|
890
978
|
visible: any[];
|
|
@@ -927,13 +1015,20 @@ declare class PageData {
|
|
|
927
1015
|
saveRecord(record: any, index?: number | null): Promise<boolean>;
|
|
928
1016
|
/** Deletes record index after the question; browser list, or the button's backend (then reloads). */
|
|
929
1017
|
remove(index: number, button?: any): Promise<boolean>;
|
|
930
|
-
/**
|
|
1018
|
+
/**
|
|
1019
|
+
* Sends one record (index) or all ('all') to the backend the button describes; afterSuccess removeLocal.
|
|
1020
|
+
* All are sent one by one (option.sendMode "single", the default): what the backend takes goes, what it refuses
|
|
1021
|
+
* stays, marked with the reason (SEND_ERROR_KEY) - nothing is booked twice, nothing is lost. sendMode "bulk"
|
|
1022
|
+
* sends all in one call (all taken or all refused). OFFENE-PUNKTE 131: a refused entry looked like one never sent.
|
|
1023
|
+
*/
|
|
931
1024
|
send(button: any, index: number | 'all'): Promise<boolean>;
|
|
932
1025
|
/** Filter fields are the keys set by setFilter; a filter page loads only when none is empty. */
|
|
933
1026
|
private filterComplete;
|
|
934
1027
|
private loadBackendRecords;
|
|
935
1028
|
/** A filter date goes on as a Date - the call writes it by the page's dateFormat. */
|
|
936
1029
|
private filterValue;
|
|
1030
|
+
/** The records as they are now into the browser list (a mark set or cleared). */
|
|
1031
|
+
private persist;
|
|
937
1032
|
private removeLocal;
|
|
938
1033
|
/** The old delete address "orders/{{id}}" took record[button.key] for any placeholder. */
|
|
939
1034
|
private legacyUrl;
|
|
@@ -994,6 +1089,7 @@ declare class CardComponent {
|
|
|
994
1089
|
paginationMode: 'client' | 'server';
|
|
995
1090
|
paginationLoading: boolean;
|
|
996
1091
|
/** The Designer's canvas: sample records, every element with drag, edit and delete, nothing loaded (design/design.ts). */
|
|
1092
|
+
get designTranslations(): Readonly<Record<string, string>> | undefined;
|
|
997
1093
|
design: VlDesign | null;
|
|
998
1094
|
/** What was chosen or changed on the Designer's canvas. */
|
|
999
1095
|
designChange: EventEmitter<DesignEvent>;
|
|
@@ -1075,7 +1171,9 @@ declare class CardComponent {
|
|
|
1075
1171
|
invokeOnCardFooter(element: any): void;
|
|
1076
1172
|
/** Delete (asks first) and save to a backend go to the page's data; anything else to the app. */
|
|
1077
1173
|
invokeButtonClick(layout: any, record: any, recordIndex: any): Promise<void>;
|
|
1078
|
-
/**
|
|
1174
|
+
/** The line above a refused record: "Not saved: <reason>" in the project's language (notSentReason, {reason}). */
|
|
1175
|
+
sendErrorText(record: any): string;
|
|
1176
|
+
/** "Save all": every record of the page - one after another, or in one call with sendMode "bulk" (PageData.send). */
|
|
1079
1177
|
saveAllData(option: any): Promise<void>;
|
|
1080
1178
|
showLinkDetails(option: any, record: any): void;
|
|
1081
1179
|
showImageDetails(option: any, record: any): void;
|
|
@@ -1089,6 +1187,10 @@ declare class CardComponent {
|
|
|
1089
1187
|
classes: string;
|
|
1090
1188
|
style: Record<string, any>;
|
|
1091
1189
|
};
|
|
1190
|
+
/** The cards of a row equally high, their buttons at the bottom (center.option.alignRows, catalog alignRowsOf). */
|
|
1191
|
+
alignRows(): boolean;
|
|
1192
|
+
/** An element of the card that holds buttons (a button, or a row with one) - it goes to the bottom of an aligned card. */
|
|
1193
|
+
isActionLayout(layout: any): boolean;
|
|
1092
1194
|
getCardContainerStyle(): Record<string, any>;
|
|
1093
1195
|
getSingleCardStyle(): Record<string, any>;
|
|
1094
1196
|
getHeaderStyle(): Record<string, any>;
|
|
@@ -1171,6 +1273,7 @@ interface SectionDesignerHost {
|
|
|
1171
1273
|
deselect(): void;
|
|
1172
1274
|
/** the view is drawn again (the apps run without zone.js: a change after a timer is not seen otherwise) */
|
|
1173
1275
|
refresh(): void;
|
|
1276
|
+
requestDelete(target: DesignTarget, name: string, remove: () => void, current: () => boolean): void;
|
|
1174
1277
|
}
|
|
1175
1278
|
/** The data a field carries while it is dragged inside its container. */
|
|
1176
1279
|
interface SectionDragData {
|
|
@@ -1231,25 +1334,27 @@ declare class SectionDesigner {
|
|
|
1231
1334
|
declare function isSignedIn(userInfo: any, now?: number): boolean;
|
|
1232
1335
|
type LockReason = 'login' | 'valid' | null;
|
|
1233
1336
|
/** Why a button is locked: needsLogin without a signed-in user first, then needsValid with a broken rule. */
|
|
1234
|
-
declare function lockReason(option: any, state:
|
|
1235
|
-
signedIn: boolean;
|
|
1236
|
-
valid: boolean;
|
|
1237
|
-
}): LockReason;
|
|
1337
|
+
declare function lockReason(option: any, state: LockState): LockReason;
|
|
1238
1338
|
/** Every reason a button is locked, the sign-in first: both show their hint under the button. */
|
|
1239
|
-
declare function lockReasons(option: any, state:
|
|
1339
|
+
declare function lockReasons(option: any, state: LockState): Array<'login' | 'valid'>;
|
|
1340
|
+
/**
|
|
1341
|
+
* What a container knows when it decides about a button: signed in, every rule kept (needsValid), and every
|
|
1342
|
+
* required field filled (requiredFilled - left out, nothing is checked).
|
|
1343
|
+
*/
|
|
1344
|
+
interface LockState {
|
|
1240
1345
|
signedIn: boolean;
|
|
1241
1346
|
valid: boolean;
|
|
1242
|
-
|
|
1347
|
+
requiredFilled?: boolean;
|
|
1348
|
+
}
|
|
1349
|
+
/** A button that sends its form's fields - submit or save; it never sends an empty required field. */
|
|
1350
|
+
declare function sendsForm(option: any): boolean;
|
|
1243
1351
|
/** A hint under a locked button: the layout's text; for 'login' a link to the sign-in. */
|
|
1244
1352
|
interface LockHint {
|
|
1245
1353
|
reason: 'login' | 'valid';
|
|
1246
1354
|
text: string;
|
|
1247
1355
|
}
|
|
1248
1356
|
/** Whether a button is locked: needsLogin without a signed-in user, needsValid with a broken rule. */
|
|
1249
|
-
declare function buttonLocked(option: any, state:
|
|
1250
|
-
signedIn: boolean;
|
|
1251
|
-
valid: boolean;
|
|
1252
|
-
}): boolean;
|
|
1357
|
+
declare function buttonLocked(option: any, state: LockState): boolean;
|
|
1253
1358
|
/**
|
|
1254
1359
|
* The hint under a locked button: the layout's caption for the reason (option.needsLoginHint.caption /
|
|
1255
1360
|
* needsValidHint.caption), in the app's language when the language file has it (the caption is its key).
|
|
@@ -1298,6 +1403,7 @@ declare class FormComponent implements OnInit, OnChanges, AfterViewInit, OnDestr
|
|
|
1298
1403
|
/** the hint of a button locked for a missing sign-in was clicked: the app starts its sign-in */
|
|
1299
1404
|
signIn: EventEmitter<void>;
|
|
1300
1405
|
/** The Designer's canvas: every section and field with drag, edit and delete, nothing loaded (design/design.ts). */
|
|
1406
|
+
get designTranslations(): Readonly<Record<string, string>> | undefined;
|
|
1301
1407
|
design: VlDesign | null;
|
|
1302
1408
|
/** What was chosen or changed on the Designer's canvas. */
|
|
1303
1409
|
designChange: EventEmitter<DesignEvent>;
|
|
@@ -1362,6 +1468,8 @@ declare class FormComponent implements OnInit, OnChanges, AfterViewInit, OnDestr
|
|
|
1362
1468
|
key: string;
|
|
1363
1469
|
label: string;
|
|
1364
1470
|
}>;
|
|
1471
|
+
/** Every required field of the shown sections filled, the required card whole - a sending button waits for it (121). */
|
|
1472
|
+
requiredFilled(form: NgForm | null): boolean;
|
|
1365
1473
|
/**
|
|
1366
1474
|
* A click on a locked button: nothing is sent; every field shows its message. The page stays where it is.
|
|
1367
1475
|
*/
|
|
@@ -1444,6 +1552,11 @@ declare class GridComponent implements AfterViewInit, OnDestroy {
|
|
|
1444
1552
|
}>;
|
|
1445
1553
|
gridForm?: NgForm;
|
|
1446
1554
|
/** The Designer's canvas: sample rows, every column with drag, edit, delete and resize, nothing loaded (design/design.ts). */
|
|
1555
|
+
readonly vlFieldKey: typeof testFieldKey;
|
|
1556
|
+
readonly vlFieldPath: typeof testFieldPath;
|
|
1557
|
+
readonly vlAction: typeof testAction;
|
|
1558
|
+
readonly vlWrites: typeof testWrites;
|
|
1559
|
+
get designTranslations(): Readonly<Record<string, string>> | undefined;
|
|
1447
1560
|
design: VlDesign | null;
|
|
1448
1561
|
/** What was chosen or changed on the Designer's canvas. */
|
|
1449
1562
|
designChange: EventEmitter<DesignEvent>;
|
|
@@ -1524,7 +1637,13 @@ declare class GridComponent implements AfterViewInit, OnDestroy {
|
|
|
1524
1637
|
};
|
|
1525
1638
|
onScrollEvent(event: any): void;
|
|
1526
1639
|
showLinkDetails(option: any, data: any): void;
|
|
1640
|
+
/** A text of the layout in the app's language - its key in the language file, else as written. */
|
|
1641
|
+
private inLanguage;
|
|
1642
|
+
/** The empty list's text (layoutSchema.noRecordMessage) in the app's language. */
|
|
1643
|
+
get noRecordText(): string;
|
|
1527
1644
|
invokeGridBtnClick(option: any, propertySchema: any): void;
|
|
1645
|
+
/** A row's button: its record goes along, like a card's button (add to cart, open, dialog …). */
|
|
1646
|
+
invokeRowBtnClick(option: any, record: any): void;
|
|
1528
1647
|
/**
|
|
1529
1648
|
* An action icon of a row (save / delete of an action column) calls its address. The address is filled per click
|
|
1530
1649
|
* from the layout ({{field}} = the row's field) - the layout's own option stays as it is (it was overwritten, a
|
|
@@ -1622,6 +1741,11 @@ declare class HeaderMenuComponent implements AfterViewInit {
|
|
|
1622
1741
|
private platform;
|
|
1623
1742
|
/** Marks for the app's test runner (#166): field key and button action. */
|
|
1624
1743
|
readonly vlFieldKey: typeof testFieldKey;
|
|
1744
|
+
readonly vlFieldPath: typeof testFieldPath;
|
|
1745
|
+
/** The search field's key at the bottom right (Designer: option.enterKey) - Search unless set otherwise. */
|
|
1746
|
+
searchEnterKey(element: any): string;
|
|
1747
|
+
/** The search field's keyboard by the rule of every field: its keyboardType, else a text field's (user 2026-10-31). */
|
|
1748
|
+
searchKeyboard(element: any): string | null;
|
|
1625
1749
|
readonly vlAction: typeof testAction;
|
|
1626
1750
|
readonly vlWrites: typeof testWrites;
|
|
1627
1751
|
isLogined: boolean;
|
|
@@ -1633,12 +1757,32 @@ declare class HeaderMenuComponent implements AfterViewInit {
|
|
|
1633
1757
|
projectSeleted: any;
|
|
1634
1758
|
/** The signed-in user - its name for the user element. */
|
|
1635
1759
|
userInfo: any;
|
|
1760
|
+
/** The title of the page shown, in the app's language - the app hands it (element kind title). */
|
|
1761
|
+
pageTitle: string;
|
|
1636
1762
|
cartInfo: any;
|
|
1637
1763
|
buttonClick: EventEmitter<any>;
|
|
1638
1764
|
showTableContent: EventEmitter<any>;
|
|
1639
1765
|
searchItems: EventEmitter<any>;
|
|
1766
|
+
design: VlDesign | null;
|
|
1767
|
+
designChange: EventEmitter<DesignEvent>;
|
|
1768
|
+
private readonly designId;
|
|
1769
|
+
get dt(): _yomotech_view_toolkit.DesignTexts;
|
|
1770
|
+
get designItems(): any[];
|
|
1771
|
+
get shownItems(): any[];
|
|
1772
|
+
path(parent: number[], index: number): number[];
|
|
1773
|
+
listId(path: number[]): string;
|
|
1774
|
+
listIds(): string[];
|
|
1775
|
+
chosen(path: number[]): boolean;
|
|
1776
|
+
choose(path: number[], event?: Event): void;
|
|
1777
|
+
elementClicked(element: any, path: number[], event: Event): void;
|
|
1778
|
+
selectHeader(): void;
|
|
1779
|
+
private applyHeader;
|
|
1780
|
+
elementAction(action: DesignAction, path: number[]): void;
|
|
1781
|
+
elementDropped(event: CdkDragDrop<any>, parent: number[]): void;
|
|
1782
|
+
text(value: any): string;
|
|
1783
|
+
pictureOf(element: any): string;
|
|
1640
1784
|
private readonly cdr;
|
|
1641
|
-
constructor(oktaAuthService: OktaAuthStateService, requestService: RequestService, utilityService: UtilityService, couchdbService: Couchdb, platform: Platform);
|
|
1785
|
+
constructor(oktaAuthService: OktaAuthStateService | null, requestService: RequestService, utilityService: UtilityService, couchdbService: Couchdb, platform: Platform);
|
|
1642
1786
|
ngOnChanges(changes: SimpleChanges): void;
|
|
1643
1787
|
ngAfterViewInit(): void;
|
|
1644
1788
|
getStyle(styleObject: any): Record<string, any>;
|
|
@@ -1646,7 +1790,7 @@ declare class HeaderMenuComponent implements AfterViewInit {
|
|
|
1646
1790
|
classNames(styleObject: any): string;
|
|
1647
1791
|
isVisible(header: any): boolean;
|
|
1648
1792
|
/** The kinds of header elements; a group holds elements of its own. */
|
|
1649
|
-
static readonly KINDS: readonly ["image", "text", "button", "search", "cart", "user", "group"];
|
|
1793
|
+
static readonly KINDS: readonly ["image", "text", "title", "button", "search", "cart", "user", "group"];
|
|
1650
1794
|
/** An element's kind: its control, else (older headers) its field name or its cart action; else a button. */
|
|
1651
1795
|
kindOf(header: any): string;
|
|
1652
1796
|
/** Shown: visible, and - with islogin - only signed in (true) or only signed out (false). */
|
|
@@ -1660,8 +1804,8 @@ declare class HeaderMenuComponent implements AfterViewInit {
|
|
|
1660
1804
|
invokeHeaderButtonClick(option: any): void;
|
|
1661
1805
|
invokeShowtableContent(option: any): void;
|
|
1662
1806
|
setHeaderItems(items: any[]): Promise<any[]>;
|
|
1663
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<HeaderMenuComponent,
|
|
1664
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<HeaderMenuComponent, "vl-header-menu", never, { "headerItems": { "alias": "headerItems"; "required": false; }; "headerLayout": { "alias": "headerLayout"; "required": false; }; "environment": { "alias": "environment"; "required": false; }; "tenantName": { "alias": "tenantName"; "required": false; }; "projectSeleted": { "alias": "projectSeleted"; "required": false; }; "userInfo": { "alias": "userInfo"; "required": false; }; "cartInfo": { "alias": "cartInfo"; "required": false; }; }, { "buttonClick": "buttonClick"; "showTableContent": "showTableContent"; "searchItems": "searchItems"; }, never, never, true, never>;
|
|
1807
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<HeaderMenuComponent, [{ optional: true; }, null, null, null, null]>;
|
|
1808
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<HeaderMenuComponent, "vl-header-menu", never, { "headerItems": { "alias": "headerItems"; "required": false; }; "headerLayout": { "alias": "headerLayout"; "required": false; }; "environment": { "alias": "environment"; "required": false; }; "tenantName": { "alias": "tenantName"; "required": false; }; "projectSeleted": { "alias": "projectSeleted"; "required": false; }; "userInfo": { "alias": "userInfo"; "required": false; }; "pageTitle": { "alias": "pageTitle"; "required": false; }; "cartInfo": { "alias": "cartInfo"; "required": false; }; "design": { "alias": "design"; "required": false; }; }, { "buttonClick": "buttonClick"; "showTableContent": "showTableContent"; "searchItems": "searchItems"; "designChange": "designChange"; }, never, never, true, never>;
|
|
1665
1809
|
}
|
|
1666
1810
|
|
|
1667
1811
|
declare class NetworkLogService {
|
|
@@ -1705,6 +1849,7 @@ declare class ModelComponent implements OnChanges, OnDestroy {
|
|
|
1705
1849
|
userInfo: any;
|
|
1706
1850
|
setFormDataHandler?: () => void | Promise<void>;
|
|
1707
1851
|
/** The Designer's canvas: every field with drag, edit and delete, nothing loaded or sent (design/design.ts). */
|
|
1852
|
+
get designTranslations(): Readonly<Record<string, string>> | undefined;
|
|
1708
1853
|
design: VlDesign | null;
|
|
1709
1854
|
/** What was chosen or changed on the Designer's canvas. */
|
|
1710
1855
|
designChange: EventEmitter<DesignEvent>;
|
|
@@ -1756,7 +1901,14 @@ declare class ModelComponent implements OnChanges, OnDestroy {
|
|
|
1756
1901
|
timeChangeEvent(formField: any, value: any): void;
|
|
1757
1902
|
handleRules(formField: any, value: any): void;
|
|
1758
1903
|
resetRule(rule: any, formField: any): void;
|
|
1904
|
+
/** The field names of a duration rule - none fixed: this field and rule.with, the first in the dialog is "from". */
|
|
1905
|
+
private durationFields;
|
|
1759
1906
|
isRuleTriggered(rule: any, formField: any): boolean;
|
|
1907
|
+
/**
|
|
1908
|
+
* The duration of a time range: from / to are this field and rule.with (or params.fromTime / toTime), on the
|
|
1909
|
+
* day of params.fromDate; params.durationField gets "h:mm", params.toDate the end's day (overnight: the next day).
|
|
1910
|
+
* No field name is fixed - the Designer's rule names them (OFFENE-PUNKTE 116 G).
|
|
1911
|
+
*/
|
|
1760
1912
|
applyDurationRule(rule: any, formField: any): void;
|
|
1761
1913
|
invokeSetformData(): void;
|
|
1762
1914
|
invokeFormBtnClick(option: any, propertySchema: any, form: NgForm): void;
|
|
@@ -1963,6 +2115,44 @@ declare class SideMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
|
1963
2115
|
private mobileLoginSubscription?;
|
|
1964
2116
|
private mobileLoginRequestInProgress;
|
|
1965
2117
|
private currentMobileLoginToken?;
|
|
2118
|
+
design: VlDesign | null;
|
|
2119
|
+
/** The existing Main left-area layout, for its project style/classes; not a new persisted key. */
|
|
2120
|
+
menuLayout: any;
|
|
2121
|
+
designChange: EventEmitter<DesignEvent>;
|
|
2122
|
+
private readonly designId;
|
|
2123
|
+
designMenu: any[];
|
|
2124
|
+
get dt(): _yomotech_view_toolkit.DesignTexts;
|
|
2125
|
+
designPath(parent: number[], index: number): number[];
|
|
2126
|
+
designListId(path: number[]): string;
|
|
2127
|
+
designListIds(): string[];
|
|
2128
|
+
designEditable(path: number[]): boolean;
|
|
2129
|
+
designSelected(path: number[]): boolean;
|
|
2130
|
+
selectDesignEntry(path: number[], event?: Event): void;
|
|
2131
|
+
selectDesignMenu(): void;
|
|
2132
|
+
designMenuSelected(): boolean;
|
|
2133
|
+
/** the canvas menu folded like the app's (its handle) */
|
|
2134
|
+
designCollapsed: boolean;
|
|
2135
|
+
private designOpenPaths;
|
|
2136
|
+
designOpen(path: number[]): boolean;
|
|
2137
|
+
designFold(path: number[], open: boolean): void;
|
|
2138
|
+
designNode(path: number[]): any;
|
|
2139
|
+
/** the app has a sign-in (Main's app settings: at the start or at any time) - only then the app shows a user */
|
|
2140
|
+
designSignIn(): boolean;
|
|
2141
|
+
/** the menu's own logout entry (top level) - the app shows it as the sign-out beside the user */
|
|
2142
|
+
designLogoutPath(): number[] | null;
|
|
2143
|
+
/** "+": the Designer adds an entry at the top ([]) or into the folder of path */
|
|
2144
|
+
designAdd(path: number[]): void;
|
|
2145
|
+
menuText(item: any): string;
|
|
2146
|
+
/** The inline menu's indent of a level, as nz-menu gives it in the app (24px per level). */
|
|
2147
|
+
designIndent(parent: number[]): number;
|
|
2148
|
+
menuClasses(style: any): string;
|
|
2149
|
+
menuStyle(style: any): Record<string, any>;
|
|
2150
|
+
/** The area's style without its widths: the area (Main's left) is already that wide, the menu fills it. */
|
|
2151
|
+
designRootStyle(): Record<string, any>;
|
|
2152
|
+
private refreshDesignMenu;
|
|
2153
|
+
private applyDesignMenu;
|
|
2154
|
+
designEntryAction(action: DesignAction, path: number[]): void;
|
|
2155
|
+
designEntryDropped(event: CdkDragDrop<any>, parent: number[]): void;
|
|
1966
2156
|
menuItems: any[];
|
|
1967
2157
|
userInfo: any;
|
|
1968
2158
|
settings: any;
|
|
@@ -1979,6 +2169,12 @@ declare class SideMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
|
1979
2169
|
private rawMenuItems;
|
|
1980
2170
|
/** The codes of the project's language files ("en", "de") for the entry Languages. */
|
|
1981
2171
|
private projectLanguages;
|
|
2172
|
+
/** The page a menu entry opens as tests name it ("pages/sidemenu/books/layout_schema.json" -> "sidemenu/books"). */
|
|
2173
|
+
vlPage(item: any): string | null;
|
|
2174
|
+
/** The language codes the project has (its languages/<code>.json) - the test runner runs a flow in each. */
|
|
2175
|
+
languageCodes(): string[];
|
|
2176
|
+
/** The language shown now ("de"). */
|
|
2177
|
+
currentLanguageCode(): string;
|
|
1982
2178
|
/** Set once the user picks a language in the menu - the start language then no longer applies. */
|
|
1983
2179
|
private languageChosenByUser;
|
|
1984
2180
|
languageChange: EventEmitter<any>;
|
|
@@ -2034,6 +2230,8 @@ declare class SideMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
|
2034
2230
|
* Mobile menu (overlay when open, no width when closed, styles under :host(.sidemenu-mobile)):
|
|
2035
2231
|
* the app on iOS and Android - phones and tablets - and small browser windows.
|
|
2036
2232
|
*/
|
|
2233
|
+
get mobileClass(): boolean;
|
|
2234
|
+
get menuDesignClass(): boolean;
|
|
2037
2235
|
mobileMode: boolean;
|
|
2038
2236
|
onResizeMobileMode(): void;
|
|
2039
2237
|
private computeMobileMode;
|
|
@@ -2047,6 +2245,8 @@ declare class SideMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
|
2047
2245
|
private destroyOktaSubscription;
|
|
2048
2246
|
private destroyMobileLoginSubscription;
|
|
2049
2247
|
private clearLoginUser;
|
|
2248
|
+
/** Login in the setting menu follows the provider's sign-in - rebuilt when it comes or goes. */
|
|
2249
|
+
private refreshSettingEntries;
|
|
2050
2250
|
getUserInfoFromToken(token: string): any | null;
|
|
2051
2251
|
/**
|
|
2052
2252
|
* Whether a menu entry is hidden: sign-in (option.login) like before, and an entry with option.role only for a
|
|
@@ -2082,7 +2282,7 @@ declare class SideMenuComponent implements AfterViewInit, OnChanges, OnDestroy {
|
|
|
2082
2282
|
private applyMenuTranslations;
|
|
2083
2283
|
private applySettingTranslations;
|
|
2084
2284
|
static ɵfac: i0.ɵɵFactoryDeclaration<SideMenuComponent, never>;
|
|
2085
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SideMenuComponent, "vl-side-menu", never, { "menuItems": { "alias": "menuItems"; "required": false; }; "userInfo": { "alias": "userInfo"; "required": false; }; "settings": { "alias": "settings"; "required": false; }; "projects": { "alias": "projects"; "required": false; }; "tenantName": { "alias": "tenantName"; "required": false; }; "environment": { "alias": "environment"; "required": false; }; "projectSeleted": { "alias": "projectSeleted"; "required": false; }; "appVersionInfo": { "alias": "appVersionInfo"; "required": false; }; "startLanguages": { "alias": "startLanguages"; "required": false; }; "mainCenter": { "alias": "mainCenter"; "required": false; }; }, { "languageChange": "languageChange"; "invokeMenu": "invokeMenu"; "menuToggle": "menuToggle"; "invokeProject": "invokeProject"; "errorMessage": "errorMessage"; "deleteProject": "deleteProject"; "paginationType": "paginationType"; }, never, never, true, never>;
|
|
2285
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SideMenuComponent, "vl-side-menu", never, { "design": { "alias": "design"; "required": false; }; "menuLayout": { "alias": "menuLayout"; "required": false; }; "menuItems": { "alias": "menuItems"; "required": false; }; "userInfo": { "alias": "userInfo"; "required": false; }; "settings": { "alias": "settings"; "required": false; }; "projects": { "alias": "projects"; "required": false; }; "tenantName": { "alias": "tenantName"; "required": false; }; "environment": { "alias": "environment"; "required": false; }; "projectSeleted": { "alias": "projectSeleted"; "required": false; }; "appVersionInfo": { "alias": "appVersionInfo"; "required": false; }; "startLanguages": { "alias": "startLanguages"; "required": false; }; "mainCenter": { "alias": "mainCenter"; "required": false; }; }, { "designChange": "designChange"; "languageChange": "languageChange"; "invokeMenu": "invokeMenu"; "menuToggle": "menuToggle"; "invokeProject": "invokeProject"; "errorMessage": "errorMessage"; "deleteProject": "deleteProject"; "paginationType": "paginationType"; }, never, never, true, never>;
|
|
2086
2286
|
}
|
|
2087
2287
|
|
|
2088
2288
|
declare class Autocomplete implements OnChanges {
|
|
@@ -2135,6 +2335,11 @@ declare class Autocomplete implements OnChanges {
|
|
|
2135
2335
|
* (phone in landscape, keyboard beside the dialog - test F15).
|
|
2136
2336
|
*/
|
|
2137
2337
|
fitList(): void;
|
|
2338
|
+
/**
|
|
2339
|
+
* The field keeps the chosen entry's value - autocomplete.response.value ("workOrderNo" -> "00100000"), not the
|
|
2340
|
+
* whole entry: the entry showed as "[object Object]" on the card and went to the backend as an object. The entry
|
|
2341
|
+
* itself goes on (picked) so the container fills other fields (onSelect.mapFields). Typed text stays as typed.
|
|
2342
|
+
*/
|
|
2138
2343
|
changed(value: any): void;
|
|
2139
2344
|
placeholder(): string;
|
|
2140
2345
|
showError(): boolean;
|
|
@@ -2381,6 +2586,16 @@ declare function timeHourFormat(languageCode?: string): '12' | '24';
|
|
|
2381
2586
|
* complete time without one gets AM (12 PM), and an hour from 13 becomes PM ("2030" -> "08:30 PM").
|
|
2382
2587
|
*/
|
|
2383
2588
|
declare function shapeTimeText(text: string, twelveHours: boolean): string;
|
|
2589
|
+
/**
|
|
2590
|
+
* AM or PM as typed after the digits: the last "a" or "p" counts - "0430p", "4:30pm", and "04:30 AMP" (P typed after
|
|
2591
|
+
* the AM the field had added) are PM; "" when none. On a laptop PM could not be typed at all (2026-10-28).
|
|
2592
|
+
*/
|
|
2593
|
+
declare function typedMeridiem(text: string): '' | 'AM' | 'PM';
|
|
2594
|
+
/** A whole 12- or 24-hour time text ("04:30 PM", "16:30") as hours and minutes of the day, or null. */
|
|
2595
|
+
declare function parseTimeText(text: string): {
|
|
2596
|
+
hours: number;
|
|
2597
|
+
minutes: number;
|
|
2598
|
+
} | null;
|
|
2384
2599
|
/** AM <-> PM of a typed 12-hour time ("08:30 AM" -> "08:30 PM"); a time without one gets PM. */
|
|
2385
2600
|
declare function toggleMeridiem(text: string): string;
|
|
2386
2601
|
|
|
@@ -2569,14 +2784,148 @@ declare class RecordStore {
|
|
|
2569
2784
|
static ɵprov: i0.ɵɵInjectableDeclaration<RecordStore>;
|
|
2570
2785
|
}
|
|
2571
2786
|
|
|
2787
|
+
declare const ADDON_API_VERSION = 1;
|
|
2788
|
+
/** addon/addon.json as the app reads it. */
|
|
2789
|
+
interface AddonManifest {
|
|
2790
|
+
addonApi?: number;
|
|
2791
|
+
entry?: string;
|
|
2792
|
+
routes?: Record<string, {
|
|
2793
|
+
handler: string;
|
|
2794
|
+
methods?: string[];
|
|
2795
|
+
}>;
|
|
2796
|
+
transforms?: Record<string, {
|
|
2797
|
+
handler: string;
|
|
2798
|
+
}>;
|
|
2799
|
+
hosts?: string[];
|
|
2800
|
+
limits?: {
|
|
2801
|
+
timeoutMs?: number;
|
|
2802
|
+
upstreamCalls?: number;
|
|
2803
|
+
};
|
|
2804
|
+
}
|
|
2805
|
+
/** The limits of a call: time, calls to other servers, records and size of the answer. */
|
|
2806
|
+
interface AddonLimits {
|
|
2807
|
+
timeoutMs: number;
|
|
2808
|
+
upstreamCalls: number;
|
|
2809
|
+
maxRecords: number;
|
|
2810
|
+
maxAnswerBytes: number;
|
|
2811
|
+
}
|
|
2812
|
+
declare function addonLimits(manifest: AddonManifest | null | undefined): AddonLimits;
|
|
2813
|
+
/** Why the manifest cannot run, or null. */
|
|
2814
|
+
declare function addonManifestProblem(manifest: AddonManifest | null | undefined): string | null;
|
|
2815
|
+
/** The function a transform name stands for (addon.json transforms), or null. */
|
|
2816
|
+
declare function transformHandler(manifest: AddonManifest | null | undefined, name: string): string | null;
|
|
2817
|
+
/** What a transform gave back, checked: a list of records within the limits; else the reason. */
|
|
2818
|
+
declare function checkTransformResult(name: string, result: unknown, limits: AddonLimits): {
|
|
2819
|
+
records?: any[];
|
|
2820
|
+
problem?: string;
|
|
2821
|
+
};
|
|
2822
|
+
/** What a route gave back, checked: { items, total } or a list; else the reason. */
|
|
2823
|
+
declare function checkRouteResult(path: string, result: any, limits: AddonLimits): {
|
|
2824
|
+
answer?: {
|
|
2825
|
+
items: any[];
|
|
2826
|
+
total: number;
|
|
2827
|
+
};
|
|
2828
|
+
problem?: string;
|
|
2829
|
+
};
|
|
2830
|
+
/**
|
|
2831
|
+
* Whether the add-on's http may call this address: an https or http address whose host is in addon.json hosts.
|
|
2832
|
+
* A host "{{name}}" is the value the app knows under that name (the sign-in, the Configuration).
|
|
2833
|
+
*/
|
|
2834
|
+
declare function addonHostAllowed(url: string, hosts: string[] | undefined, values?: Record<string, any>): boolean;
|
|
2835
|
+
/** Whether a file of addon/ is code the app loads: .js / .mjs, not a test (*.spec.mjs) and not under tests/. */
|
|
2836
|
+
declare function isAddonCode(path: string): boolean;
|
|
2837
|
+
|
|
2838
|
+
declare class AddonHostService {
|
|
2839
|
+
private readonly couchdb;
|
|
2840
|
+
private dbName;
|
|
2841
|
+
private values;
|
|
2842
|
+
private prepared;
|
|
2843
|
+
private worker;
|
|
2844
|
+
private workerReady;
|
|
2845
|
+
private onLoaded;
|
|
2846
|
+
private readonly urls;
|
|
2847
|
+
private readonly calls;
|
|
2848
|
+
private seq;
|
|
2849
|
+
private upstreamLeft;
|
|
2850
|
+
/**
|
|
2851
|
+
* The project whose add-on runs (its database, "<tenant>_<project>"), and the values a host "{{name}}" of
|
|
2852
|
+
* addon.json stands for. Another project: the old add-on is stopped.
|
|
2853
|
+
*/
|
|
2854
|
+
useProject(dbName: string, values?: Record<string, any>): void;
|
|
2855
|
+
/** The values for hosts "{{name}}" anew (after the sign-in). */
|
|
2856
|
+
setValues(values: Record<string, any>): void;
|
|
2857
|
+
/** Records through the add-on's transform (addon.json transforms.<name>): records in, records out. */
|
|
2858
|
+
transform(name: string, records: any[], params?: Record<string, any>): Promise<any[]>;
|
|
2859
|
+
/** Data of the add-on's route (addon.json routes, GET): { items, total }. */
|
|
2860
|
+
route(path: string, query: Record<string, any>, page?: number, size?: number): Promise<{
|
|
2861
|
+
items: any[];
|
|
2862
|
+
total: number;
|
|
2863
|
+
}>;
|
|
2864
|
+
private prepare;
|
|
2865
|
+
/** addon.json and the add-on's code files from the project, linked from the entry file on. */
|
|
2866
|
+
private load;
|
|
2867
|
+
private blobUrl;
|
|
2868
|
+
private startWorker;
|
|
2869
|
+
private call;
|
|
2870
|
+
private onMessage;
|
|
2871
|
+
/** The add-on's http.get: only the hosts of addon.json, at most limits.upstreamCalls per call. */
|
|
2872
|
+
private answerHttp;
|
|
2873
|
+
private stopWorker;
|
|
2874
|
+
private reset;
|
|
2875
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<AddonHostService, never>;
|
|
2876
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<AddonHostService>;
|
|
2877
|
+
}
|
|
2878
|
+
|
|
2879
|
+
/** The add-on's own files, path below addon/ -> source ("main.js", "zeiterfassung/tagesbuchungen.js"). */
|
|
2880
|
+
type AddonFiles = Record<string, string>;
|
|
2881
|
+
/**
|
|
2882
|
+
* The source with its comments blanked (same length, line breaks kept): an "import ... from" in a comment is no
|
|
2883
|
+
* import - test-kit.js shows one as an example and was read as importing itself (2026-10-28).
|
|
2884
|
+
*/
|
|
2885
|
+
declare function blankComments(source: string): string;
|
|
2886
|
+
/** The names a file imports, in order. */
|
|
2887
|
+
declare function addonImports(source: string): string[];
|
|
2888
|
+
/**
|
|
2889
|
+
* The file an import names, below addon/ - null when it is no file of the add-on: a package ("lodash"), an
|
|
2890
|
+
* address ("https://…"), a path leaving addon/ ("../x.js").
|
|
2891
|
+
*/
|
|
2892
|
+
declare function resolveAddonPath(from: string, specifier: string): string | null;
|
|
2893
|
+
/**
|
|
2894
|
+
* Links the add-on's files from the entry on: every import is replaced by the address makeUrl gives the imported
|
|
2895
|
+
* file (a blob: address in the app). Gives the entry's address. Throws with the file and the import when an import
|
|
2896
|
+
* is not allowed or not found, or files import each other in a circle.
|
|
2897
|
+
*/
|
|
2898
|
+
declare function linkAddonModules(files: AddonFiles, entry: string, makeUrl: (source: string, path: string) => string): string;
|
|
2899
|
+
|
|
2900
|
+
/** The source of addon/test-kit.js - plain JavaScript, no import. */
|
|
2901
|
+
declare const ADDON_TEST_KIT = "/**\n * Test kit of this add-on - written by the Designer, do not change. A test file (*.spec.mjs) imports it:\n * import { test, expect } from './test-kit.js'; (from a folder: '../test-kit.js')\n * test('one entry over two days gives two bookings', () => {\n * expect(dailyLogs({ records: [...] })).toHaveLength(2);\n * });\n * In the Designer: button \"Tests\". In VS Code: node addon/<folder>/<name>.spec.mjs\n */\nconst tests = [];\nlet scheduled = false;\nconst inNode = typeof process !== 'undefined' && !!(process.versions && process.versions.node);\n\nexport function test(name, fn) {\n tests.push({ name: String(name), fn });\n if (inNode && !scheduled) {\n scheduled = true;\n setTimeout(async () => {\n const results = await runTests();\n for (const r of results) console.log((r.ok ? '\u2714 ' : '\u2716 ') + r.name + (r.ok ? '' : '\\n ' + r.error));\n const failed = results.filter((r) => !r.ok).length;\n console.log(failed ? failed + ' of ' + results.length + ' failed' : results.length + ' passed');\n if (failed) process.exitCode = 1;\n }, 0);\n }\n}\n\nfunction show(value) {\n try { return JSON.stringify(value); } catch (e) { return String(value); }\n}\n\nfunction same(a, b) {\n if (Object.is(a, b)) return true;\n if (a instanceof Date && b instanceof Date) return a.getTime() === b.getTime();\n if (!a || !b || typeof a !== 'object' || typeof b !== 'object') return false;\n if (Array.isArray(a) !== Array.isArray(b)) return false;\n const ka = Object.keys(a), kb = Object.keys(b);\n return ka.length === kb.length && ka.every((k) => same(a[k], b[k]));\n}\n\nexport function expect(actual) {\n const fail = (text) => { throw new Error(text); };\n return {\n toBe: (expected) => Object.is(actual, expected) || fail('expected ' + show(expected) + ', got ' + show(actual)),\n toEqual: (expected) => same(actual, expected) || fail('expected ' + show(expected) + ', got ' + show(actual)),\n toBeTruthy: () => !!actual || fail('expected a true value, got ' + show(actual)),\n toBeFalsy: () => !actual || fail('expected a false value, got ' + show(actual)),\n toHaveLength: (n) => (actual && actual.length === n) || fail('expected length ' + n + ', got ' + (actual ? actual.length : show(actual))),\n toContain: (item) => (actual && actual.includes && actual.includes(item)) || fail(show(actual) + ' does not contain ' + show(item)),\n toThrow: () => {\n try { actual(); } catch (e) { return true; }\n return fail('expected an error');\n },\n };\n}\n\n/** Runs the collected tests one after another: [{ name, ok, error }]. */\nexport async function runTests() {\n const results = [];\n for (const t of tests.splice(0)) {\n try {\n await t.fn();\n results.push({ name: t.name, ok: true });\n } catch (e) {\n results.push({ name: t.name, ok: false, error: String((e && e.message) || e) });\n }\n }\n return results;\n}\n";
|
|
2902
|
+
/** One test of a run: its file, its name, passed or the reason. */
|
|
2903
|
+
interface AddonTestResult {
|
|
2904
|
+
file: string;
|
|
2905
|
+
name: string;
|
|
2906
|
+
ok: boolean;
|
|
2907
|
+
error?: string;
|
|
2908
|
+
}
|
|
2909
|
+
/** A test file of the add-on: *.spec.mjs / *.spec.js below addon/. */
|
|
2910
|
+
declare function isAddonTestFile(path: string): boolean;
|
|
2911
|
+
/**
|
|
2912
|
+
* Runs every test file of the add-on (path -> source, addon/test-kit.js among them) in a Web Worker without network,
|
|
2913
|
+
* one file after the other, each under timeoutMs. A file that does not load, or runs too long, is one failed result.
|
|
2914
|
+
*/
|
|
2915
|
+
declare function runAddonTests(files: AddonFiles, timeoutMs?: number): Promise<AddonTestResult[]>;
|
|
2916
|
+
|
|
2572
2917
|
declare class BackendCallService {
|
|
2573
2918
|
private readonly remoteLists;
|
|
2574
2919
|
private readonly utilityService;
|
|
2575
2920
|
private readonly oauthService;
|
|
2921
|
+
private readonly addons;
|
|
2576
2922
|
/** The signed-in user (claims + token): from the app, else the stored sign-in. */
|
|
2577
2923
|
currentUser(): Promise<any>;
|
|
2578
|
-
/**
|
|
2579
|
-
|
|
2924
|
+
/**
|
|
2925
|
+
* The records after the option's conversion: "addon:<name>" runs the project's add-on (addon.json transforms,
|
|
2926
|
+
* OFFENE-PUNKTE 92), another name a conversion of the library; unknown names change nothing.
|
|
2927
|
+
*/
|
|
2928
|
+
transform(option: any, records: any[]): Promise<any[]>;
|
|
2580
2929
|
/** Sends the records to the option's backend; true on success. */
|
|
2581
2930
|
saveData(option: any, records: any[], extra?: CallContext): Promise<any>;
|
|
2582
2931
|
/** Loads from the option's backend with the given context (e.g. filter values). */
|
|
@@ -2805,6 +3154,11 @@ declare class CheckboxControl {
|
|
|
2805
3154
|
errorMessages: any;
|
|
2806
3155
|
translations: Record<string, string> | null;
|
|
2807
3156
|
inputStyle: any;
|
|
3157
|
+
/**
|
|
3158
|
+
* The input style without its widths: a field's "width: 100%" made the box as wide as the row and squeezed the
|
|
3159
|
+
* caption to a letter per line (tm-test Controls Dialog); a check box keeps its own size.
|
|
3160
|
+
*/
|
|
3161
|
+
get boxStyle(): any;
|
|
2808
3162
|
toggled: EventEmitter<any>;
|
|
2809
3163
|
private control?;
|
|
2810
3164
|
private get option();
|
|
@@ -2844,6 +3198,13 @@ declare class DateTimeControl {
|
|
|
2844
3198
|
placeholder(): string;
|
|
2845
3199
|
/** typed digits shaped into the pattern, like the toolkit keyboard does */
|
|
2846
3200
|
typing(event: any): void;
|
|
3201
|
+
/**
|
|
3202
|
+
* A whole typed time becomes the field's value - the picker read "16:30" in a 12-hour field as nothing and the
|
|
3203
|
+
* field was empty after leaving it. The day of the value stays (a time field keeps its date part).
|
|
3204
|
+
*/
|
|
3205
|
+
private takeTypedTime;
|
|
3206
|
+
/** In a 12-hour time field the arrow keys up / down switch AM <-> PM (as in usual time fields). */
|
|
3207
|
+
timeKey(event: KeyboardEvent): void;
|
|
2847
3208
|
shown(value: any): string;
|
|
2848
3209
|
showError(): boolean;
|
|
2849
3210
|
message(): string;
|
|
@@ -2951,6 +3312,18 @@ declare class ControlComponent implements OnChanges {
|
|
|
2951
3312
|
lockHints: LockHint[];
|
|
2952
3313
|
/** 'edit': the field to type in (dialog, form); 'display': a record's value shown (card, grid) */
|
|
2953
3314
|
mode: 'edit' | 'display';
|
|
3315
|
+
/**
|
|
3316
|
+
* A field shown in a list (card, grid row) names itself like a form field does (data-vl-field / data-vl-path), so
|
|
3317
|
+
* the app's test runner finds it there too - before, a card's fields had no name and a check of the card hit the
|
|
3318
|
+
* closed dialog's field instead (2026-10-29). In edit mode the form's wrapper carries the name.
|
|
3319
|
+
*/
|
|
3320
|
+
get hostFieldKey(): string | null;
|
|
3321
|
+
get hostFieldPath(): string | null;
|
|
3322
|
+
/** A shown text ends with … after the field's maxLines (Designer: Lines at most) - only where it is shown in a list. */
|
|
3323
|
+
get clamped(): boolean;
|
|
3324
|
+
get maxLines(): string | null;
|
|
3325
|
+
/** The key at the bottom right of the app keyboard (Designer: option.enterKey) - the keyboard reads it here. */
|
|
3326
|
+
get hostEnterKey(): string | null;
|
|
2954
3327
|
/** display mode: the record whose value is shown (record[name]) */
|
|
2955
3328
|
record: any;
|
|
2956
3329
|
/** no label (a grid cell: the column's heading is the label) */
|
|
@@ -2998,7 +3371,7 @@ declare class ControlComponent implements OnChanges {
|
|
|
2998
3371
|
name: string;
|
|
2999
3372
|
ngOnChanges(): void;
|
|
3000
3373
|
get display(): boolean;
|
|
3001
|
-
/**
|
|
3374
|
+
/** a list: the value is shown, not typed in (protected in a form is a locked input, see ruleField) */
|
|
3002
3375
|
get readonly(): boolean;
|
|
3003
3376
|
/**
|
|
3004
3377
|
* the value shown: in a list what the record stores (never the property's default - that belongs
|
|
@@ -3024,6 +3397,10 @@ declare class ControlComponent implements OnChanges {
|
|
|
3024
3397
|
/** label.value, the layout's label.caption, then the data object's caption - translated */
|
|
3025
3398
|
get label(): string;
|
|
3026
3399
|
/** a required field (option.required true) shows a red * after its label */
|
|
3400
|
+
/**
|
|
3401
|
+
* The red * of a required field - not on a locked field (option.disabled, read-only): the person cannot fill it,
|
|
3402
|
+
* a rule or the app does (tm-test "To Date" is set from "From Date") - user 2026-10-29: no locked field carries a *.
|
|
3403
|
+
*/
|
|
3027
3404
|
get required(): boolean;
|
|
3028
3405
|
/** a button click: a locked one sends nothing (no submit either) and asks the container to show what is missing */
|
|
3029
3406
|
onButton(event: Event): void;
|
|
@@ -3036,6 +3413,8 @@ declare class ControlComponent implements OnChanges {
|
|
|
3036
3413
|
classes: string;
|
|
3037
3414
|
style: Record<string, any>;
|
|
3038
3415
|
};
|
|
3416
|
+
/** the card field's parts: one Stripe line, or number / expiry / CVC in two or three rows (OFFENE-PUNKTE 103) */
|
|
3417
|
+
get cardLayout(): CardLayout;
|
|
3039
3418
|
/** scope.style: the input's own style in the layout (the Designer's "input" style) */
|
|
3040
3419
|
inputStyle(): {
|
|
3041
3420
|
classes: string;
|
|
@@ -3061,6 +3440,13 @@ declare class ControlComponent implements OnChanges {
|
|
|
3061
3440
|
* used for a new record only (dialog). A placeholder always becomes the value.
|
|
3062
3441
|
*/
|
|
3063
3442
|
declare function applyLayoutDefaults(schemas: Record<string, any>, layout: any, asValue: boolean): void;
|
|
3443
|
+
/**
|
|
3444
|
+
* The start values from the signed-in user ({{userInfo.email}}, or {{email}} with option.fromUser) into the fields -
|
|
3445
|
+
* when the form opens and again when the sign-in comes or goes. A locked field (protected / disabled) always shows the
|
|
3446
|
+
* user's value; an open field only while it is empty or still holds what the sign-in put there, so a typed value
|
|
3447
|
+
* stays. Without a sign-in the field is empty, never the placeholder text (user 2026-10-29, luv2shop checkout).
|
|
3448
|
+
*/
|
|
3449
|
+
declare function fillFromUser(schemas: Record<string, any>, userInfo: any): void;
|
|
3064
3450
|
|
|
3065
3451
|
/** How many of the form's 12 columns a section takes: gridSpan 1..12, else the whole width. */
|
|
3066
3452
|
declare function sectionSpan(section: any): number;
|
|
@@ -3148,5 +3534,29 @@ declare function sampleValue(type: string | undefined, name: string, index: numb
|
|
|
3148
3534
|
*/
|
|
3149
3535
|
declare function sampleRecords(nodes: any[], propertySchema: any, count: number, image?: string): any[];
|
|
3150
3536
|
|
|
3151
|
-
|
|
3152
|
-
|
|
3537
|
+
type TreeKey = 'elements' | 'submenu';
|
|
3538
|
+
declare function validTreePath(path: number[]): boolean;
|
|
3539
|
+
declare function treeNode(items: any[], path: number[], key: TreeKey): any;
|
|
3540
|
+
declare function treePaths(items: any[], key: TreeKey, parent?: number[]): number[][];
|
|
3541
|
+
declare function replaceTreeNode(items: any[], path: number[], value: any, key: TreeKey): any[];
|
|
3542
|
+
declare function removeTreeNode(items: any[], path: number[], key: TreeKey): any[];
|
|
3543
|
+
/** destinationIndex is the insertion index after removal, like CDK's currentIndex. */
|
|
3544
|
+
declare function moveTreeNode(items: any[], from: number[], parent: number[], destinationIndex: number, key: TreeKey): any[];
|
|
3545
|
+
|
|
3546
|
+
type DesignTranslations = Readonly<Record<string, string>>;
|
|
3547
|
+
declare function designText(text: any, translations?: DesignTranslations | null): string;
|
|
3548
|
+
declare function designField<T>(field: T, translations?: DesignTranslations | null): T;
|
|
3549
|
+
|
|
3550
|
+
declare class DesignFieldPipe implements PipeTransform {
|
|
3551
|
+
transform<T>(value: T, translations?: DesignTranslations | null): T;
|
|
3552
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<DesignFieldPipe, never>;
|
|
3553
|
+
static ɵpipe: i0.ɵɵPipeDeclaration<DesignFieldPipe, "vlDesignField", true>;
|
|
3554
|
+
}
|
|
3555
|
+
declare class DesignTextPipe implements PipeTransform {
|
|
3556
|
+
transform(value: any, translations?: DesignTranslations | null): string;
|
|
3557
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<DesignTextPipe, never>;
|
|
3558
|
+
static ɵpipe: i0.ɵɵPipeDeclaration<DesignTextPipe, "vlDesignText", true>;
|
|
3559
|
+
}
|
|
3560
|
+
|
|
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 };
|