@j2inn/resolvable-ui-elements 2.0.0 → 2.1.0

package/dist_es/resolvableElements/elements/expr/ResolvableExprElement.js

@@ -1,102 +1,102 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import { HNum } from 'haystack-core';
-import { millisecond, second } from 'haystack-units';
-import { replaceTemplateVariables } from '../../resolveTemplatedExpression';
-import { ResolvableValueElement } from '../ResolvableValueElement';
-const GRID_VAL_COLUMN_NAME = 'val';
-/**
- * Resolves to the result of an expression.
- */
-export class ResolvableExprElement extends ResolvableValueElement {
-    constructor(data) {
-        super(data);
-    }
-    refreshes = 0;
-    #timeout;
-    getMeta = () => this._meta;
-    doInitialize = async (parameters) => {
-        const { refreshAfter } = this.getMeta();
-        await this.#updateValue(parameters);
-        if (refreshAfter) {
-            this.#setRefreshTimeout(refreshAfter, parameters);
-        }
-    };
-    #setRefreshTimeout = (refreshAfter, parameters) => {
-        this.#timeout = setTimeout(() => {
-            this.refreshes++;
-            this.#updateValue(parameters);
-            this.#setRefreshTimeout(refreshAfter, parameters);
-        }, HNum.make(refreshAfter, second).convertTo(millisecond).value);
-    };
-    #updateValue = async (parameters) => {
-        const { expr, path } = this.getMeta();
-        const grid = await this.resolver.evalExprElement(expr, parameters, path);
-        this.value = this.#unpackResult(grid);
-    };
-    /**
-     * Unpacks grid if expected `resolvedType` result requires it.
-     * @param grid result grid
-     * @returns unpacked value
-     */
-    #unpackResult = (grid) => {
-        // Identify when it's necessary to unpack the result from `val` column or not
-        if (this.isExpectedResultACollection()) {
-            if (!grid.hasColumn(GRID_VAL_COLUMN_NAME)) {
-                this.#logValColumnNotFound(grid);
-            }
-            // Unpack val column into array
-            return grid.map((row) => row.get(GRID_VAL_COLUMN_NAME));
-        }
-        else if (this.isExpectedResultVal()) {
-            if (!grid.hasColumn(GRID_VAL_COLUMN_NAME)) {
-                this.#logValColumnNotFound(grid);
-            }
-            // Unpack first dict val column into value
-            return grid[0]?.get(GRID_VAL_COLUMN_NAME);
-        }
-        else {
-            // Default to using the grid response as it is
-            return grid;
-        }
-    };
-    #logValColumnNotFound = (grid) => {
-        const { expr } = this.getMeta();
-        console.warn(`expected "${GRID_VAL_COLUMN_NAME}" column on expr result not found`, expr, grid);
-        grid.inspect();
-    };
-    /**
-     * Checks whether the declared resolvedType of this element is a collection.
-     * @returns true if the resolvedType is a collection.
-     */
-    isExpectedResultACollection = () => {
-        const { resolvedType } = this.getMeta();
-        return resolvedType.endsWith('[]');
-    };
-    /**
-     * Checks whether the declared resolvedType of this element is a single value.
-     * @returns true if the resolvedType is a value.
-     */
-    isExpectedResultVal = () => {
-        const { resolvedType } = this.getMeta();
-        return resolvedType !== 'HGrid' && !this.isExpectedResultACollection();
-    };
-    doClose = async () => {
-        if (this.#timeout) {
-            clearTimeout(this.#timeout);
-        }
-    };
-    getParameterList = () => {
-        const { expr } = this.getMeta();
-        const parameters = [];
-        if (expr) {
-            replaceTemplateVariables(expr, (_, match) => {
-                parameters.push(match);
-                return '';
-            });
-        }
-        return parameters;
-    };
-}
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import { HNum } from 'haystack-core';
+import { millisecond, second } from 'haystack-units';
+import { replaceTemplateVariables } from '../../resolveTemplatedExpression';
+import { ResolvableValueElement } from '../ResolvableValueElement';
+const GRID_VAL_COLUMN_NAME = 'val';
+/**
+ * Resolves to the result of an expression.
+ */
+export class ResolvableExprElement extends ResolvableValueElement {
+    constructor(data) {
+        super(data);
+    }
+    refreshes = 0;
+    #timeout;
+    getMeta = () => this._meta;
+    doInitialize = async (parameters) => {
+        const { refreshAfter } = this.getMeta();
+        await this.#updateValue(parameters);
+        if (refreshAfter) {
+            this.#setRefreshTimeout(refreshAfter, parameters);
+        }
+    };
+    #setRefreshTimeout = (refreshAfter, parameters) => {
+        this.#timeout = setTimeout(() => {
+            this.refreshes++;
+            this.#updateValue(parameters);
+            this.#setRefreshTimeout(refreshAfter, parameters);
+        }, HNum.make(refreshAfter, second).convertTo(millisecond).value);
+    };
+    #updateValue = async (parameters) => {
+        const { expr, path } = this.getMeta();
+        const grid = await this.resolver.evalExprElement(expr, parameters, path);
+        this.value = this.#unpackResult(grid);
+    };
+    /**
+     * Unpacks grid if expected `resolvedType` result requires it.
+     * @param grid result grid
+     * @returns unpacked value
+     */
+    #unpackResult = (grid) => {
+        // Identify when it's necessary to unpack the result from `val` column or not
+        if (this.isExpectedResultACollection()) {
+            if (!grid.hasColumn(GRID_VAL_COLUMN_NAME)) {
+                this.#logValColumnNotFound(grid);
+            }
+            // Unpack val column into array
+            return grid.map((row) => row.get(GRID_VAL_COLUMN_NAME));
+        }
+        else if (this.isExpectedResultVal()) {
+            if (!grid.hasColumn(GRID_VAL_COLUMN_NAME)) {
+                this.#logValColumnNotFound(grid);
+            }
+            // Unpack first dict val column into value
+            return grid[0]?.get(GRID_VAL_COLUMN_NAME);
+        }
+        else {
+            // Default to using the grid response as it is
+            return grid;
+        }
+    };
+    #logValColumnNotFound = (grid) => {
+        const { expr } = this.getMeta();
+        console.warn(`expected "${GRID_VAL_COLUMN_NAME}" column on expr result not found`, expr, grid);
+        grid.inspect();
+    };
+    /**
+     * Checks whether the declared resolvedType of this element is a collection.
+     * @returns true if the resolvedType is a collection.
+     */
+    isExpectedResultACollection = () => {
+        const { resolvedType } = this.getMeta();
+        return resolvedType.endsWith('[]');
+    };
+    /**
+     * Checks whether the declared resolvedType of this element is a single value.
+     * @returns true if the resolvedType is a value.
+     */
+    isExpectedResultVal = () => {
+        const { resolvedType } = this.getMeta();
+        return resolvedType !== 'HGrid' && !this.isExpectedResultACollection();
+    };
+    doClose = async () => {
+        if (this.#timeout) {
+            clearTimeout(this.#timeout);
+        }
+    };
+    getParameterList = () => {
+        const { expr } = this.getMeta();
+        const parameters = [];
+        if (expr) {
+            replaceTemplateVariables(expr, (_, match) => {
+                parameters.push(match);
+                return '';
+            });
+        }
+        return parameters;
+    };
+}
 //# sourceMappingURL=ResolvableExprElement.js.map

package/dist_es/resolvableElements/elements/expr/ResolvableExprElementMeta.d.ts

@@ -1,10 +1,10 @@
-import { ResolvableValueElementMeta } from '../ResolvableValueElement';
-import { UiElementData, UiElementMeta } from '../UiElement';
-export interface ResolvableExprElementMeta extends ResolvableValueElementMeta {
-    resolutionType: 'expr';
-    expr: string;
-    refreshAfter: number;
-    path?: string;
-}
-export declare const isResolvableExprElementData: (element: UiElementData) => element is UiElementData<ResolvableExprElementMeta>;
-export declare const isResolvableExprElementMeta: (meta: UiElementMeta) => meta is ResolvableExprElementMeta;
+import { ResolvableValueElementMeta } from '../ResolvableValueElement';
+import { UiElementData, UiElementMeta } from '../UiElement';
+export interface ResolvableExprElementMeta extends ResolvableValueElementMeta {
+    resolutionType: 'expr';
+    expr: string;
+    refreshAfter: number;
+    path?: string;
+}
+export declare const isResolvableExprElementData: (element: UiElementData) => element is UiElementData<ResolvableExprElementMeta>;
+export declare const isResolvableExprElementMeta: (meta: UiElementMeta) => meta is ResolvableExprElementMeta;

package/dist_es/resolvableElements/elements/expr/ResolvableExprElementMeta.js

@@ -1,10 +1,10 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-export const isResolvableExprElementData = (element) => {
-    return !!element?._meta && isResolvableExprElementMeta(element?._meta);
-};
-export const isResolvableExprElementMeta = (meta) => {
-    return meta.resolutionType === 'expr';
-};
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+export const isResolvableExprElementData = (element) => {
+    return !!element?._meta && isResolvableExprElementMeta(element?._meta);
+};
+export const isResolvableExprElementMeta = (meta) => {
+    return meta.resolutionType === 'expr';
+};
 //# sourceMappingURL=ResolvableExprElementMeta.js.map

package/dist_es/resolvableElements/elements/function/FunctionElement.d.ts

@@ -1,12 +1,12 @@
-import { DictStore, HaysonVal, HDict, HGrid, OptionalHVal } from 'haystack-core';
-import { UiElement, UiElementConstructorData, UiElementData } from '../UiElement';
-/**
- * Resolves to a function that can be called to achieve side effects.
- */
-export declare class FunctionElement<T extends UiElementData> extends UiElement<T> {
-    #private;
-    constructor(data: UiElementConstructorData<T>);
-}
-export type FunctionResult = (parameters: Parameters) => Promise<HGrid>;
-export type Parameters = Record<string, OptionalHVal | HaysonVal | undefined> | OptionalHVal | DictStore | undefined;
-export declare const makeParametersDict: (parameters: Record<string, OptionalHVal | HaysonVal | undefined> | OptionalHVal | DictStore | undefined) => HDict;
+import { DictStore, HaysonVal, HDict, HGrid, OptionalHVal } from 'haystack-core';
+import { UiElement, UiElementConstructorData, UiElementData } from '../UiElement';
+/**
+ * Resolves to a function that can be called to achieve side effects.
+ */
+export declare class FunctionElement<T extends UiElementData> extends UiElement<T> {
+    #private;
+    constructor(data: UiElementConstructorData<T>);
+}
+export type FunctionResult = (parameters: Parameters) => Promise<HGrid>;
+export type Parameters = Record<string, OptionalHVal | HaysonVal | undefined> | OptionalHVal | DictStore | undefined;
+export declare const makeParametersDict: (parameters: Record<string, OptionalHVal | HaysonVal | undefined> | OptionalHVal | DictStore | undefined) => HDict;

package/dist_es/resolvableElements/elements/function/FunctionElement.js

@@ -1,37 +1,37 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import { HDict } from 'haystack-core';
-import { UiElement, } from '../UiElement';
-/**
- * Resolves to a function that can be called to achieve side effects.
- */
-export class FunctionElement extends UiElement {
-    constructor(data) {
-        super(data);
-        if (this.isAccessAllowed(this._meta)) {
-            this.value = this.#buildFunction();
-        }
-    }
-    #buildFunction = () => {
-        const { expr, path } = this._meta;
-        return async (parameters) => {
-            const result = await this.resolver.evalExprElement(expr, makeParametersDict(parameters), path);
-            // Update watch records
-            if (!result.isError()) {
-                this.resolver.client.ops.watch.update(result.filter('id and mod'));
-            }
-            return result;
-        };
-    };
-}
-export const makeParametersDict = (parameters) => {
-    if (!parameters) {
-        return HDict.make();
-    }
-    if (parameters instanceof HDict) {
-        return parameters;
-    }
-    return HDict.make(Object.fromEntries(Object.entries(parameters).filter(([, v]) => v != null)));
-};
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import { HDict } from 'haystack-core';
+import { UiElement, } from '../UiElement';
+/**
+ * Resolves to a function that can be called to achieve side effects.
+ */
+export class FunctionElement extends UiElement {
+    constructor(data) {
+        super(data);
+        if (this.isAccessAllowed(this._meta)) {
+            this.value = this.#buildFunction();
+        }
+    }
+    #buildFunction = () => {
+        const { expr, path } = this._meta;
+        return async (parameters) => {
+            const result = await this.resolver.evalExprElement(expr, makeParametersDict(parameters), path);
+            // Update watch records
+            if (!result.isError()) {
+                this.resolver.client.ops.watch.update(result.filter('id and mod'));
+            }
+            return result;
+        };
+    };
+}
+export const makeParametersDict = (parameters) => {
+    if (!parameters) {
+        return HDict.make();
+    }
+    if (parameters instanceof HDict) {
+        return parameters;
+    }
+    return HDict.make(Object.fromEntries(Object.entries(parameters).filter(([, v]) => v != null)));
+};
 //# sourceMappingURL=FunctionElement.js.map

package/dist_es/resolvableElements/elements/function/FunctionElementMeta.d.ts

@@ -1,9 +1,9 @@
-import { ResolvableValueElementMeta } from '../ResolvableValueElement';
-import { UiElementData, UiElementMeta } from '../UiElement';
-export interface FunctionElementMeta extends ResolvableValueElementMeta {
-    resolutionType: 'function';
-    expr: string;
-    path?: string;
-}
-export declare const isFunctionElementData: (element: UiElementData) => element is UiElementData<FunctionElementMeta>;
-export declare const isFunctionElementMeta: (meta: UiElementMeta) => meta is FunctionElementMeta;
+import { ResolvableValueElementMeta } from '../ResolvableValueElement';
+import { UiElementData, UiElementMeta } from '../UiElement';
+export interface FunctionElementMeta extends ResolvableValueElementMeta {
+    resolutionType: 'function';
+    expr: string;
+    path?: string;
+}
+export declare const isFunctionElementData: (element: UiElementData) => element is UiElementData<FunctionElementMeta>;
+export declare const isFunctionElementMeta: (meta: UiElementMeta) => meta is FunctionElementMeta;

package/dist_es/resolvableElements/elements/function/FunctionElementMeta.js

@@ -1,10 +1,10 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-export const isFunctionElementData = (element) => {
-    return !!element?._meta && isFunctionElementMeta(element._meta);
-};
-export const isFunctionElementMeta = (meta) => {
-    return meta.resolutionType === 'function';
-};
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+export const isFunctionElementData = (element) => {
+    return !!element?._meta && isFunctionElementMeta(element._meta);
+};
+export const isFunctionElementMeta = (meta) => {
+    return meta.resolutionType === 'function';
+};
 //# sourceMappingURL=FunctionElementMeta.js.map

package/dist_es/resolvableElements/elements/list/ListElementMeta.d.ts

@@ -1,12 +1,12 @@
-import { ResolvableValueElementMeta } from '../ResolvableValueElement';
-import { UiElementData, UiElementMeta } from '../UiElement';
-export interface ResolvableListElementMeta extends ResolvableValueElementMeta {
-    resolutionType: 'list';
-    parentBinding?: string;
-    entityBinding?: string;
-    subscribe?: boolean;
-    subscribePollRate?: number;
-    orderBy: string | string[];
-}
-export declare const isResolvableListElementData: (element: UiElementData) => element is UiElementData<ResolvableListElementMeta>;
-export declare const isResolvableListElementMeta: (meta: UiElementMeta) => meta is ResolvableListElementMeta;
+import { ResolvableValueElementMeta } from '../ResolvableValueElement';
+import { UiElementData, UiElementMeta } from '../UiElement';
+export interface ResolvableListElementMeta extends ResolvableValueElementMeta {
+    resolutionType: 'list';
+    parentBinding?: string;
+    entityBinding?: string;
+    subscribe?: boolean;
+    subscribePollRate?: number;
+    orderBy: string | string[];
+}
+export declare const isResolvableListElementData: (element: UiElementData) => element is UiElementData<ResolvableListElementMeta>;
+export declare const isResolvableListElementMeta: (meta: UiElementMeta) => meta is ResolvableListElementMeta;

package/dist_es/resolvableElements/elements/list/ListElementMeta.js

@@ -1,10 +1,10 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-export const isResolvableListElementData = (element) => {
-    return !!element?._meta && isResolvableListElementMeta(element._meta);
-};
-export const isResolvableListElementMeta = (meta) => {
-    return meta.resolutionType === 'list';
-};
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+export const isResolvableListElementData = (element) => {
+    return !!element?._meta && isResolvableListElementMeta(element._meta);
+};
+export const isResolvableListElementMeta = (meta) => {
+    return meta.resolutionType === 'list';
+};
 //# sourceMappingURL=ListElementMeta.js.map

package/dist_es/resolvableElements/elements/list/ResolvableListElement.d.ts

@@ -1,16 +1,16 @@
-import { HDict } from 'haystack-core';
-import { Watch } from 'haystack-nclient';
-import { ResolvableValueElement } from '../ResolvableValueElement';
-import { UiElementConstructorData, UiElementData } from '../UiElement';
-/**
- * Resolves to a list of records and keeps them updated using a watch.
- */
-export declare class ResolvableListElement<T extends UiElementData> extends ResolvableValueElement<T> {
-    #private;
-    constructor(data: UiElementConstructorData<T>);
-    filter?: string;
-    watch?: Watch;
-    protected doInitialize: (parameters: HDict) => Promise<void>;
-    protected doClose: () => Promise<void>;
-    getParameterList: () => string[];
-}
+import { HDict } from 'haystack-core';
+import { Watch } from 'haystack-nclient';
+import { ResolvableValueElement } from '../ResolvableValueElement';
+import { UiElementConstructorData, UiElementData } from '../UiElement';
+/**
+ * Resolves to a list of records and keeps them updated using a watch.
+ */
+export declare class ResolvableListElement<T extends UiElementData> extends ResolvableValueElement<T> {
+    #private;
+    constructor(data: UiElementConstructorData<T>);
+    filter?: string;
+    watch?: Watch;
+    protected doInitialize: (parameters: HDict) => Promise<void>;
+    protected doClose: () => Promise<void>;
+    getParameterList: () => string[];
+}