@reveldigital/player-client 2.0.5 → 2.2.0

package/fesm2022/reveldigital-player-client.mjs

@@ -11,8 +11,203 @@ import { RouterModule } from '@angular/router';
 import { APP_BASE_HREF } from '@angular/common';
 import * as i1$1 from '@angular/platform-browser';
 
+/**
+ * Angular-friendly wrapper around the global `gadgets.reveldigital.datatable` library.
+ *
+ * Provides typed Promise-based methods and RxJS Observables for real-time events.
+ *
+ * ```typescript
+ * const dt = this.client.createDataTable('tbl_menu_items');
+ *
+ * // Fetch rows
+ * const result = await dt.getRows({ sort: 'price', sortDir: 'asc' });
+ *
+ * // Real-time updates
+ * dt.rowUpdated$.subscribe(change => console.log('Updated:', change));
+ *
+ * // Cleanup
+ * dt.dispose();
+ * ```
+ */
+class DataTableRef {
+    /**
+     * Creates a new DataTableRef.
+     *
+     * @param tableId - The data table ID (e.g. 'tbl_menu_items')
+     * @param options - Optional configuration overrides
+     * @throws Error if the global datatable library is not loaded
+     */
+    constructor(tableId, options) {
+        /** Emits when an existing row is modified. */
+        this.rowUpdated$ = new Subject();
+        /** Emits when a new row is added. */
+        this.rowCreated$ = new Subject();
+        /** Emits when a row is removed. */
+        this.rowDeleted$ = new Subject();
+        const lib = window.gadgets?.['reveldigital.datatable'];
+        if (!lib || typeof lib.create !== 'function') {
+            throw new Error('RevelDigital DataTable library is not available. ' +
+                'Ensure the datatable feature is enabled for this gadget.');
+        }
+        this._instance = lib.create(tableId, options);
+        this._wireEvents();
+    }
+    /**
+     * Fetches rows from the data table.
+     *
+     * @param params - Optional query parameters (filter, sort, pagination)
+     * @returns Promise resolving to the result set
+     *
+     * ```typescript
+     * const result = await dt.getRows({
+     *   filter: { category: 'Entree', price: { op: 'lte', value: 25 } },
+     *   sort: 'itemName',
+     *   sortDir: 'asc',
+     *   pageSize: 20
+     * });
+     * ```
+     */
+    getRows(params) {
+        return this._instance.getRows(params);
+    }
+    /**
+     * Fetches the table schema (column definitions and metadata).
+     *
+     * @returns Promise resolving to the table schema
+     */
+    getSchema() {
+        return this._instance.getSchema();
+    }
+    /**
+     * Gets visible (non-hidden) columns from the table schema.
+     *
+     * @returns Promise resolving to an array of visible column definitions
+     */
+    getVisibleColumns() {
+        return this._instance.getVisibleColumns();
+    }
+    /**
+     * Fetches rows with hidden column data stripped.
+     *
+     * @param params - Optional query parameters (same as getRows)
+     * @returns Promise resolving to the result set with hidden fields removed
+     */
+    getVisibleRows(params) {
+        return this._instance.getVisibleRows(params);
+    }
+    /**
+     * Starts polling for changes at the given interval.
+     * Emits on `rowUpdated$` when new data is detected.
+     *
+     * @param intervalMs - Polling interval in milliseconds (default 30000)
+     */
+    startPolling(intervalMs) {
+        this._instance.startPolling(intervalMs);
+    }
+    /**
+     * Stops polling for changes.
+     */
+    stopPolling() {
+        this._instance.stopPolling();
+    }
+    /**
+     * Releases all resources: stops polling, closes the real-time connection,
+     * removes event listeners, and completes all RxJS observables.
+     */
+    dispose() {
+        this._instance.off('rowUpdated', this._onRowUpdated);
+        this._instance.off('rowCreated', this._onRowCreated);
+        this._instance.off('rowDeleted', this._onRowDeleted);
+        this._instance.dispose();
+        this.rowUpdated$.complete();
+        this.rowCreated$.complete();
+        this.rowDeleted$.complete();
+    }
+    /** @ignore */
+    static _fromInstance(instance) {
+        const ref = Object.create(DataTableRef.prototype);
+        ref.rowUpdated$ = new Subject();
+        ref.rowCreated$ = new Subject();
+        ref.rowDeleted$ = new Subject();
+        ref._instance = instance;
+        ref._wireEvents();
+        return ref;
+    }
+    /** @ignore */
+    _wireEvents() {
+        this._onRowUpdated = (change) => this.rowUpdated$.next(change);
+        this._onRowCreated = (change) => this.rowCreated$.next(change);
+        this._onRowDeleted = (change) => this.rowDeleted$.next(change);
+        this._instance.on('rowUpdated', this._onRowUpdated);
+        this._instance.on('rowCreated', this._onRowCreated);
+        this._instance.on('rowDeleted', this._onRowDeleted);
+    }
+}
+/**
+ * Wrapper around a data table created from a gadget preference value.
+ *
+ * Automatically configures filter and sort settings from the preference,
+ * and provides a `getFilteredRows()` convenience method that applies them.
+ *
+ * ```typescript
+ * const cfg = this.client.createDataTableFromPref(prefs.getString('rdDataTable'));
+ *
+ * // Fetch rows with auto-wired filter + sort from the preference
+ * const result = await cfg.getFilteredRows();
+ *
+ * // Access the underlying DataTableRef for schema, events, etc.
+ * cfg.dataTable.rowUpdated$.subscribe(change => console.log(change));
+ *
+ * // Cleanup
+ * cfg.dispose();
+ * ```
+ */
+class DataTablePrefRef {
+    /**
+     * Creates a new DataTablePrefRef from a gadget preference JSON string.
+     *
+     * @param prefValue - The raw gadget preference string (JSON)
+     * @param options - Optional configuration overrides
+     * @throws Error if the global datatable library is not loaded
+     */
+    constructor(prefValue, options) {
+        const lib = window.gadgets?.['reveldigital.datatable'];
+        if (!lib || typeof lib.createFromPref !== 'function') {
+            throw new Error('RevelDigital DataTable library is not available. ' +
+                'Ensure the datatable feature is enabled for this gadget.');
+        }
+        this._config = lib.createFromPref(prefValue, options);
+        this.pref = this._config.pref;
+        this.dataTable = DataTableRef._fromInstance(this._config.dt);
+    }
+    /**
+     * Fetches rows with the filter and sort settings from the preference automatically applied.
+     * Additional query parameters can override or supplement the preference settings.
+     *
+     * @param params - Optional additional query parameters
+     * @returns Promise resolving to the result set
+     *
+     * ```typescript
+     * // Use preference defaults
+     * const result = await cfg.getFilteredRows();
+     *
+     * // Override page size
+     * const page = await cfg.getFilteredRows({ pageSize: 10 });
+     * ```
+     */
+    getFilteredRows(params) {
+        return this._config.getFilteredRows(params);
+    }
+    /**
+     * Releases all resources held by the underlying DataTableRef.
+     */
+    dispose() {
+        this.dataTable.dispose();
+    }
+}
+
 // Generated by genversion.
-const version = '2.0.5';
+const version = '2.2.0';
 
 /**
  * Service for interacting with the Revel Digital player client.
@@ -145,22 +340,21 @@ class PlayerClientService {
                 this.onConfig$.next(null);
             }
         }), tap(e => this.onPostMessage$.next(e)));
-        let self = this;
         window.RevelDigital = {
             Controller: {
-                onCommand: function (name, arg) {
+                onCommand: (name, arg) => {
                     zone.run(() => {
-                        self.onCommand$.next({ name: name, arg: arg });
+                        this.onCommand$.next({ name: name, arg: arg });
                     });
                 },
-                onStart: function () {
+                onStart: () => {
                     zone.run(() => {
-                        self.onStart$.next(null);
+                        this.onStart$.next(null);
                     });
                 },
-                onStop: function () {
+                onStop: () => {
                     zone.run(() => {
-                        self.onStop$.next(null);
+                        this.onStop$.next(null);
                     });
                 }
             }
@@ -649,7 +843,7 @@ class PlayerClientService {
      */
     async getDevice() {
         const client = await this.getClient();
-        let obj = JSON.parse(await client.getDevice());
+        const obj = JSON.parse(await client.getDevice());
         const device = [obj].map((device) => {
             return {
                 name: device.name,
@@ -801,6 +995,69 @@ class PlayerClientService {
             console.log('%capplyConfig() is only available in preview mode.', 'background-color:blue; color:yellow;');
         }
     }
+    /**
+     * Creates a typed wrapper for a Revel Digital data table.
+     *
+     * The data table feature must be enabled for the gadget. The returned
+     * {@link DataTableRef} provides typed Promise-based methods and RxJS
+     * Observables for real-time row change events.
+     *
+     * @param tableId - The data table ID (e.g. 'tbl_menu_items')
+     * @param options - Optional configuration overrides
+     * @returns A {@link DataTableRef} instance
+     * @throws Error if the global datatable library is not loaded
+     *
+     * ```typescript
+     * const dt = this.client.createDataTable('tbl_menu_items');
+     *
+     * // Fetch rows with filtering and sorting
+     * const result = await dt.getRows({
+     *   filter: { category: 'Entree', price: { op: 'lte', value: 25 } },
+     *   sort: 'price',
+     *   sortDir: 'asc'
+     * });
+     *
+     * // Subscribe to real-time updates
+     * dt.rowUpdated$.subscribe(change => console.log('Row updated:', change));
+     * dt.rowCreated$.subscribe(change => console.log('Row created:', change));
+     * dt.rowDeleted$.subscribe(change => console.log('Row deleted:', change));
+     *
+     * // Cleanup when done
+     * dt.dispose();
+     * ```
+     */
+    createDataTable(tableId, options) {
+        return new DataTableRef(tableId, options);
+    }
+    /**
+     * Creates a typed data table wrapper from a gadget preference value.
+     *
+     * The preference JSON string (as serialized by the template editor's datatable
+     * option) is parsed and used to auto-configure filter, sort, and logic settings.
+     * The returned {@link DataTablePrefRef} provides a `getFilteredRows()` convenience
+     * method that applies these settings automatically.
+     *
+     * @param prefValue - The raw gadget preference string (JSON)
+     * @param options - Optional configuration overrides
+     * @returns A {@link DataTablePrefRef} instance
+     * @throws Error if the global datatable library is not loaded
+     *
+     * ```typescript
+     * const cfg = this.client.createDataTableFromPref(prefs.getString('rdDataTable'));
+     *
+     * // Fetch rows with auto-wired filter + sort
+     * const result = await cfg.getFilteredRows();
+     *
+     * // Access the underlying DataTableRef for events, schema, etc.
+     * cfg.dataTable.rowUpdated$.subscribe(change => console.log(change));
+     *
+     * // Cleanup when done
+     * cfg.dispose();
+     * ```
+     */
+    createDataTableFromPref(prefValue, options) {
+        return new DataTablePrefRef(prefValue, options);
+    }
     // ---
     // PRIVATE METHODS.
     // ---
@@ -927,7 +1184,7 @@ class NoopClient {
         return Promise.resolve(version);
     }
     applyConfig(prefs) {
-        let evt = { type: 'applyConfig', prefs: prefs, isOpener: window.opener !== null };
+        const evt = { type: 'applyConfig', prefs: prefs, isOpener: window.opener !== null };
         if (window.opener) {
             window.opener.postMessage(JSON.stringify(evt), '*');
         }
@@ -947,7 +1204,7 @@ class AppInitService {
         this._router = _router;
     }
     init() {
-        return new Promise(async (resolve) => {
+        return new Promise((resolve) => {
             this.loadFonts();
             if (isDevMode()) {
                 console.log('%cRunning in development mode', 'background-color:blue; color:yellow;');
@@ -965,7 +1222,7 @@ class AppInitService {
                         getLang() { return this.getParameterByName('lang') === '' ? 'en' : this.getParameterByName('lang'); }
                         getParameterByName(name, search = window.location.href) {
                             name = name.replace(/[\[\]]/g, '\\$&');
-                            let regex = new RegExp('[?&]' + name + '(=([^&#]*)|&|#|$)'), results = regex.exec(search);
+                            const regex = new RegExp('[?&]' + name + '(=([^&#]*)|&|#|$)'), results = regex.exec(search);
                             if (!results)
                                 return '';
                             if (!results[2])
@@ -979,7 +1236,7 @@ class AppInitService {
                 }).subscribe({
                     next: (data) => {
                         const doc = yaml.load(data);
-                        let params = {};
+                        const params = {};
                         for (const val of doc.prefs) {
                             params[val.name] = val.default_value;
                         }
@@ -999,9 +1256,9 @@ class AppInitService {
         });
     }
     getFamilyName(css) {
-        let FONT_FAMILY_REGEX = /font-family:\s*(?:['"])*['"]*(.+?)['"]*(?:['"])*\s*;/i;
+        const FONT_FAMILY_REGEX = /font-family:\s*(?:['"])*['"]*(.+?)['"]*(?:['"])*\s*;/i;
         if (FONT_FAMILY_REGEX.test(css)) {
-            var matches = css.match(FONT_FAMILY_REGEX);
+            const matches = css.match(FONT_FAMILY_REGEX);
             return matches[1].split(',')[0];
         }
         else {
@@ -1015,7 +1272,7 @@ class AppInitService {
         const parameters = new URLSearchParams(window.location.search);
         parameters.forEach((val, key) => {
             try {
-                let fontFamily = this.getFamilyName(val);
+                const fontFamily = this.getFamilyName(val);
                 if (fontFamily !== '') {
                     WebFont.load({
                         google: {
@@ -1152,5 +1409,5 @@ function initializeApp(appInitService) {
  * Generated bundle index. Do not edit.
  */
 
-export { NgSafeStylePipeModule, PlayerClientModule, PlayerClientService, SafeStylePipe };
+export { DataTablePrefRef, DataTableRef, NgSafeStylePipeModule, PlayerClientModule, PlayerClientService, SafeStylePipe };
 //# sourceMappingURL=reveldigital-player-client.mjs.map