@yomotech/view-toolkit 1.0.35 → 1.0.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yomotech/view-toolkit",
-  "version": "1.0.35",
+  "version": "1.0.37",
   "peerDependencies": {
     "@angular/cdk": "^21.0.0",
     "@angular/common": "^21.0.0",

package/types/yomotech-view-toolkit.d.ts

@@ -73,7 +73,7 @@ declare class UtilityService {
         authParams: {
             pkce: boolean;
             issuer: any;
-            scopes: any;
+            scopes: string[] | undefined;
         };
     };
     setOktaMobileCredential(environment: any): {
@@ -85,6 +85,8 @@ declare class UtilityService {
         responseType: any;
         pkceEnabled: any;
     };
+    /** OAuth scopes as the list okta-auth-js expects; undefined lets it use its default. */
+    private oauthScopeList;
     /** OAuth scope as the space separated string the OAuth2 plugin expects. */
     private oauthScope;
     setupStripePaymentForm(environment: any, form: any, onCardChange: (message: string) => void): Promise<void>;
@@ -131,8 +133,37 @@ declare class Couchdb {
      * classifying it as text would change the shape they receive.
      */
     private isTextFile;
+    /** Ids of the files under a folder of the project, e.g. listFiles(db, 'ssl/mobile/'). Empty on any error. */
+    listFiles(dbName: string, prefix: string): Promise<string[]>;
     private getDocumentUrl;
     private getDbUrl;
+    private isAttachmentMedia;
+    /** Signed links by "db/doc/name", reused until a minute before they run out. */
+    private mediaLinks;
+    /**
+     * A signed link for one media attachment (#145). A <video>/<audio src> sends no tenant header,
+     * so POST /media-token is asked with it instead - the same header every read already carries,
+     * nothing else is needed - and answers the path it signed plus a token for that one file
+     * (8 hours). The player then reads couchdb.yomotech.de<path>?token=... with Range itself.
+     */
+    getMediaStreamUrl(dbName: string, docId: string, name: string): Promise<string>;
+    /**
+     * What a media field holds, made playable: a URL (http, https, data, blob) stays as it is; a
+     * file name ("clip.mp4", also "Media/clip.mp4") is read from Media/ of the selected project -
+     * a signed link for an attachment, a data URL for an older Base64 document. '' when unknown.
+     */
+    resolveMediaSource(source: string): Promise<string>;
+    /** Media prepared at the start, by "db/name": an object URL (loaded whole) or a signed link. */
+    private preloadedMedia;
+    /**
+     * Prepares the project's video and audio at the start of the app, in the background (#145): only
+     * the files in environments/media.json - the media the pages use, written by the Designer on
+     * export; without that list nothing is preloaded. Per file the signed link; a file up to maxBytes
+     * (20 MB) is loaded whole and kept as an object URL, so Play starts at once and without network. A
+     * larger one keeps only the link. A failure is no error for the app: resolveMediaSource then asks
+     * for the link as before.
+     */
+    preloadProjectMedia(dbName: string, maxBytes?: number): Promise<void>;
     private getReadHeaders;
     private buildTenantHeaders;
     getImageSrcFromCouchDb(couchDbName: string, filePath: string): Promise<string>;
@@ -321,9 +352,9 @@ declare class CustomKeyboardService {
 declare class DateTimePickerService {
     private readonly keyboard;
     /** On the devices the date picker docks at the bottom like a keyboard; in a browser it drops down. */
-    readonly isNativeMobile: boolean;
+    get isNativeMobile(): boolean;
     /** panelStyleClass of a date picker. */
-    readonly datePanelClass: string;
+    get datePanelClass(): string;
     /** panelStyleClass of a time picker: compact and attached to its field everywhere. */
     readonly timePanelClass = "model-datepicker-panel model-timepicker-panel";
     /**
@@ -331,7 +362,7 @@ declare class DateTimePickerService {
      * wrapper around the panel, and a transformed wrapper becomes the reference of the panel's
      * position: fixed - the docked calendar flew up next to its field while closing.
      */
-    readonly dockedMotion: {
+    get dockedMotion(): {
         disabled: boolean;
     } | undefined;
     private activePicker;
@@ -415,7 +446,6 @@ declare class CardComponent {
     private readonly remoteLists;
     /** Loaded lists by field reference. */
     remoteData: Record<string, any[]>;
-    private readonly cardRemoteData;
     /** Current suggestions of an autocomplete by field reference. */
     remoteSuggestions: Record<string, any[]>;
     /** Loads every backend list the given layout nodes describe; dropdown/combobox get their items. */
@@ -516,27 +546,6 @@ declare class CardComponent {
     getMediaSource(layout: any, record: any): string;
     getMediaLabel(layout: any): string;
     getMediaKind(layout: any, record: any): 'image' | 'video' | 'audio' | 'pdf' | 'file';
-    cardProperty(node: any): any;
-    cardControlProperty(node: any): any;
-    cardType(node: any): string;
-    isSharedCardField(node: any): boolean;
-    isCardGroup(node: any): boolean;
-    isCardTitle(node: any, area: string): boolean;
-    cardFieldValue(node: any, record?: any): any;
-    cardFieldCaption(node: any): string;
-    protectedCardValue(node: any, record: any, nested: boolean): string;
-    private readonly emptyCardItems;
-    cardFieldItems(node: any): any[] | undefined;
-    cardGroupStyle(node: any): Record<string, any>;
-    cardFieldWrapperStyle(node: any, nested: boolean, area: string): Record<string, any>;
-    private readonly rendererFields;
-    cardRendererField(node: any, area: string): any;
-    private cardAccess;
-    onCardFieldChange(node: any, value: any, record?: any, area?: string): void;
-    onCardItemSelected(node: any, item: any, record?: any): void;
-    private cardChangeQueued;
-    private cardDestroyed;
-    private scheduleCardDataChange;
     static ɵfac: i0.ɵɵFactoryDeclaration<CardComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CardComponent, "vl-card", never, { "itemInfo": { "alias": "itemInfo"; "required": false; }; "currentPage": { "alias": "currentPage"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; "selectedLanguageInfo": { "alias": "selectedLanguageInfo"; "required": false; }; "mobileDisplay": { "alias": "mobileDisplay"; "required": false; }; "scrollPagination": { "alias": "scrollPagination"; "required": false; }; "pages": { "alias": "pages"; "required": false; }; "paginationMode": { "alias": "paginationMode"; "required": false; }; "paginationLoading": { "alias": "paginationLoading"; "required": false; }; }, { "cardButtonClick": "cardButtonClick"; "cardHeaderButtonClick": "cardHeaderButtonClick"; "linkDetails": "linkDetails"; "imageDetails": "imageDetails"; "onPageSizeChange": "onPageSizeChange"; "onPageChange": "onPageChange"; "cardDataChange": "cardDataChange"; }, never, never, true, never>;
 }
@@ -549,6 +558,15 @@ declare class FormComponent implements OnInit, OnChanges, AfterViewInit, OnDestr
     remoteSuggestions: Record<string, any[]>;
     /** Loads every backend list the given layout nodes describe; dropdown/combobox get their items. */
     loadRemoteLists(nodes: any[], propertySchema: any): Promise<void>;
+    /** Backend lists still on the way, by field reference. */
+    remoteLoading: Record<string, boolean>;
+    private lastRemoteQuery;
+    /**
+     * What an autocomplete shows when it has no entries: "loading" while its list is on the way,
+     * "no results" after - in the project's language (autocompleteLoading, autocompleteNoResults),
+     * English when the project has no text for it.
+     */
+    autocompleteEmptyText(node: any): string;
     /** (completeMethod) of an autocomplete with a backend list. */
     completeRemote(event: any, node: any): void;
     /** Date and time picker behaviour shared by all containers. */
@@ -823,7 +841,6 @@ declare class ModelComponent implements OnChanges, OnDestroy {
     resetRule(rule: any, formField: any): void;
     isRuleTriggered(rule: any, formField: any): boolean;
     applyDurationRule(rule: any, formField: any): void;
-    private ruleClock;
     invokeSetformData(): void;
     invokeFormBtnClick(option: any, propertySchema: any, form: NgForm): void;
     checkValidty(form: NgForm): boolean;
@@ -832,11 +849,6 @@ declare class ModelComponent implements OnChanges, OnDestroy {
     getMediaSource(field: any): string;
     getMediaLabel(field: any): string;
     getMediaKind(field: any): 'image' | 'video' | 'audio' | 'pdf' | 'file';
-    sharedErrorsVisible: boolean;
-    sharedProperty(field: any): any;
-    usesSharedField(field: any): boolean;
-    private initializeSharedDefaults;
-    onSharedFieldChange(field: any, value: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ModelComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ModelComponent, "vl-model", never, { "errorMessages": { "alias": "errorMessages"; "required": false; }; "modalItemInfo": { "alias": "modalItemInfo"; "required": false; }; "selectedLanguageInfo": { "alias": "selectedLanguageInfo"; "required": false; }; "userInfo": { "alias": "userInfo"; "required": false; }; "setFormDataHandler": { "alias": "setFormDataHandler"; "required": false; }; }, {}, never, never, true, never>;
 }
@@ -1250,6 +1262,11 @@ declare class CustomKeyboardDirective implements OnDestroy {
     static ɵdir: i0.ɵɵDirectiveDeclaration<CustomKeyboardDirective, "[vlCustomKeyboard]", never, { "keyboardType": { "alias": "vlCustomKeyboard"; "required": false; }; }, {}, never, never, true, never>;
 }
 
+/** Turns the toolkit keyboards on or off in a browser (the Designer's preview, Mobile/Tablet). */
+declare function setToolkitKeyboardOnWeb(on: boolean): void;
+/** Whether fields get the toolkit keyboards: on the devices always, in a browser when switched on. */
+declare function toolkitKeyboardActive(): boolean;
+
 /**
  * The placeholder of the field `reference` in `propertySchema`, translated when the selected
  * language has an entry for it; empty when the project defines none.
@@ -1262,6 +1279,17 @@ declare class PlaceholderPipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<PlaceholderPipe, "vlPlaceholder", true>;
 }
 
+/** [src]="source | vlMedia | async" - the same Promise for the same source, so no request loop. */
+declare class MediaSourcePipe implements PipeTransform {
+    private couchdb;
+    /** Kept one hour: a signed link lasts eight, a page lives shorter. */
+    private static readonly known;
+    constructor(couchdb: Couchdb);
+    transform(source: string | null | undefined): Promise<string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MediaSourcePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<MediaSourcePipe, "vlMedia", true>;
+}
+
 interface RequestTimeoutMessages {
     requestSlow: string;
     requestStillSlow: string;
@@ -1331,5 +1359,13 @@ declare class RemoteListService {
     static ɵprov: i0.ɵɵInjectableDeclaration<RemoteListService>;
 }
 
-export { AppVersionResetService, CardComponent, ConfigService, Couchdb, CustomKeyboardComponent, CustomKeyboardDirective, CustomKeyboardService, FormComponent, GridComponent, HeaderMenuComponent, LogsComponent, MobileKeycloakService, MobileOidcService, MobileOktaService, ModelComponent, NetworkLogService, NotificationService, PaginationComponent, PlaceholderPipe, REQUEST_STAGES, RemoteListService, RequestService, RequestTimeoutError, RequestTimeoutService, SIDE_DOCK_CLASS, SideMenuComponent, UtilityService, ViewToolkitModule, isNativeMobile, isNativePhone, normalizeCustomKeyboardType, resolveCustomKeyboardType, resolvePlaceholder, sideDockWidth, stagedRequest };
+/** Prefix of the forwarding path on the app's own origin. */
+declare const BACKEND_PROXY_PREFIX = "/api/proxy";
+/**
+ * The address to call for a backend URL: unchanged on the devices and for relative URLs; in the web
+ * https://p5w1.wilken.de/p5ws/x?y=1 becomes <origin>/api/proxy/p5w1.wilken.de/p5ws/x?y=1.
+ */
+declare function backendUrl(url: string): string;
+
+export { AppVersionResetService, BACKEND_PROXY_PREFIX, CardComponent, ConfigService, Couchdb, CustomKeyboardComponent, CustomKeyboardDirective, CustomKeyboardService, FormComponent, GridComponent, HeaderMenuComponent, LogsComponent, MediaSourcePipe, MobileKeycloakService, MobileOidcService, MobileOktaService, ModelComponent, NetworkLogService, NotificationService, PaginationComponent, PlaceholderPipe, REQUEST_STAGES, RemoteListService, RequestService, RequestTimeoutError, RequestTimeoutService, SIDE_DOCK_CLASS, SideMenuComponent, UtilityService, ViewToolkitModule, backendUrl, isNativeMobile, isNativePhone, normalizeCustomKeyboardType, resolveCustomKeyboardType, resolvePlaceholder, setToolkitKeyboardOnWeb, sideDockWidth, stagedRequest, toolkitKeyboardActive };
 export type { CustomKeyboardTarget, CustomKeyboardType, MobileAuthTokens, MobileOktaRefresh, MobileOktaTokens, OidcProvider, OidcRefresh, OidcTokens, RequestTimeoutMessages };