@j2inn/resolvable-ui-elements 1.1.3 → 2.0.0

package/dist/resolvableElements/elements/section/SectionElementMeta.d.ts

@@ -1,16 +1,16 @@
-import { HVal } from 'haystack-core';
-import { UiElementData, UiElementMeta } from '../UiElement';
-export interface UiElementSectionMeta extends UiElementMeta {
-    resolutionType?: never;
-}
-export type ResolvedSection<T extends UiElementData<UiElementSectionMeta>> = T extends {
-    _resolved?: Record<string, unknown>;
-} ? Required<T>['_resolved'] : Record<string, unknown>;
-export type ParametersOfSection<T extends UiElementData> = T extends {
-    _parameters?: Record<string, HVal>;
-} ? PartialExplicitUndefined<T['_parameters']> : undefined;
-export type PartialExplicitUndefined<T> = {
-    [P in keyof T]: T[P] | null | undefined;
-};
-export declare const isSectionData: (element: UiElementData) => element is UiElementData<UiElementSectionMeta>;
-export declare const isSectionMeta: (meta: UiElementMeta | undefined) => meta is UiElementSectionMeta;
+import { HVal } from 'haystack-core';
+import { UiElementData, UiElementMeta } from '../UiElement';
+export interface UiElementSectionMeta extends UiElementMeta {
+    resolutionType?: never;
+}
+export type ResolvedSection<T extends UiElementData<UiElementSectionMeta>> = T extends {
+    _resolved?: Record<string, unknown>;
+} ? Required<T>['_resolved'] : Record<string, unknown>;
+export type ParametersOfSection<T extends UiElementData> = T extends {
+    _parameters?: Record<string, HVal>;
+} ? PartialExplicitUndefined<T['_parameters']> : undefined;
+export type PartialExplicitUndefined<T> = {
+    [P in keyof T]: T[P] | null | undefined;
+};
+export declare const isSectionData: (element: UiElementData) => element is UiElementData<UiElementSectionMeta>;
+export declare const isSectionMeta: (meta: UiElementMeta | undefined) => meta is UiElementSectionMeta;

package/dist/resolvableElements/elements/section/SectionElementMeta.js

@@ -1,12 +1,12 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSectionMeta = exports.isSectionData = void 0;
-const ResolvableValueElement_1 = require("../ResolvableValueElement");
-const isSectionData = (element) => (0, exports.isSectionMeta)(element._meta);
-exports.isSectionData = isSectionData;
-const isSectionMeta = (meta) => meta == null || !(0, ResolvableValueElement_1.isResolvableValueElementMeta)(meta);
-exports.isSectionMeta = isSectionMeta;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSectionMeta = exports.isSectionData = void 0;
+const ResolvableValueElement_1 = require("../ResolvableValueElement");
+const isSectionData = (element) => (0, exports.isSectionMeta)(element._meta);
+exports.isSectionData = isSectionData;
+const isSectionMeta = (meta) => meta == null || !(0, ResolvableValueElement_1.isResolvableValueElementMeta)(meta);
+exports.isSectionMeta = isSectionMeta;
 //# sourceMappingURL=SectionElementMeta.js.map

package/dist/resolvableElements/elements/section/resolveSection.d.ts

@@ -1,12 +1,12 @@
-import { Resolver } from 'resolvableElements/Resolver';
-import { UiElementData } from '../UiElement';
-import { ParametersOfSection, ResolvedSection } from './SectionElementMeta';
-/**
- * Resolves a section UI element.
- * @param resolver the Resolver context
- * @param sectionData section data object
- * @param parameters parameters for the resolution
- * @returns the resolved result of the section.
- */
-export declare function resolveSection<T extends UiElementData>(resolver: Resolver, sectionData: T, parameters?: ParametersOfSection<T>): Promise<ResolvedSection<T> | undefined>;
-export declare const areParametersValid: <T extends UiElementData<import("../UiElement").UiElementMeta>>(parameters: ParametersOfSection<T>) => boolean;
+import { Resolver } from 'resolvableElements/Resolver';
+import { UiElementData } from '../UiElement';
+import { ParametersOfSection, ResolvedSection } from './SectionElementMeta';
+/**
+ * Resolves a section UI element.
+ * @param resolver the Resolver context
+ * @param sectionData section data object
+ * @param parameters parameters for the resolution
+ * @returns the resolved result of the section.
+ */
+export declare function resolveSection<T extends UiElementData>(resolver: Resolver, sectionData: T, parameters?: ParametersOfSection<T>): Promise<ResolvedSection<T> | undefined>;
+export declare const areParametersValid: <T extends UiElementData<import("../UiElement").UiElementMeta>>(parameters: ParametersOfSection<T>) => boolean;

package/dist/resolvableElements/elements/section/resolveSection.js

@@ -1,42 +1,42 @@
-"use strict";
-/*
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.areParametersValid = exports.resolveSection = void 0;
-const FunctionElement_1 = require("../function/FunctionElement");
-const ResolvableSectionElement_1 = require("./ResolvableSectionElement");
-/**
- * Resolves a section UI element.
- * @param resolver the Resolver context
- * @param sectionData section data object
- * @param parameters parameters for the resolution
- * @returns the resolved result of the section.
- */
-async function resolveSection(resolver, sectionData, parameters) {
-    const parametersDict = (0, FunctionElement_1.makeParametersDict)(parameters);
-    if ((0, exports.areParametersValid)(parameters)) {
-        const sectionElement = new ResolvableSectionElement_1.ResolvableSectionElement({
-            element: sectionData,
-            resolver,
-            onUpdate: () => {
-                return;
-            },
-        });
-        await sectionElement
-            .initialize(parametersDict)
-            .finally(() => sectionElement?.close());
-        return sectionElement.value;
-    }
-    return undefined;
-}
-exports.resolveSection = resolveSection;
-const areParametersValid = (parameters) => {
-    if (parameters &&
-        Object.entries(parameters).some(([, value]) => value == null)) {
-        return false;
-    }
-    return true;
-};
-exports.areParametersValid = areParametersValid;
+"use strict";
+/*
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.areParametersValid = exports.resolveSection = void 0;
+const FunctionElement_1 = require("../function/FunctionElement");
+const ResolvableSectionElement_1 = require("./ResolvableSectionElement");
+/**
+ * Resolves a section UI element.
+ * @param resolver the Resolver context
+ * @param sectionData section data object
+ * @param parameters parameters for the resolution
+ * @returns the resolved result of the section.
+ */
+async function resolveSection(resolver, sectionData, parameters) {
+    const parametersDict = (0, FunctionElement_1.makeParametersDict)(parameters);
+    if ((0, exports.areParametersValid)(parameters)) {
+        const sectionElement = new ResolvableSectionElement_1.ResolvableSectionElement({
+            element: sectionData,
+            resolver,
+            onUpdate: () => {
+                return;
+            },
+        });
+        await sectionElement
+            .initialize(parametersDict)
+            .finally(() => sectionElement?.close());
+        return sectionElement.value;
+    }
+    return undefined;
+}
+exports.resolveSection = resolveSection;
+const areParametersValid = (parameters) => {
+    if (parameters &&
+        Object.entries(parameters).some(([, value]) => value == null)) {
+        return false;
+    }
+    return true;
+};
+exports.areParametersValid = areParametersValid;
 //# sourceMappingURL=resolveSection.js.map

package/dist/resolvableElements/elements/tag/ResolvableTagElement.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 the value of a tag on a record and keeps it updated using a watch.
- */
-export declare class ResolvableTagElement<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 the value of a tag on a record and keeps it updated using a watch.
+ */
+export declare class ResolvableTagElement<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[];
+}

package/dist/resolvableElements/elements/tag/ResolvableTagElement.js

@@ -1,106 +1,106 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResolvableTagElement = void 0;
-const haystack_core_1 = require("haystack-core");
-const haystack_nclient_1 = require("haystack-nclient");
-const resolveTemplatedExpression_1 = require("../../resolveTemplatedExpression");
-const ResolvableValueElement_1 = require("../ResolvableValueElement");
-const UiElement_1 = require("../UiElement");
-/**
- * Resolves to the value of a tag on a record and keeps it updated using a watch.
- */
-class ResolvableTagElement extends ResolvableValueElement_1.ResolvableValueElement {
-    constructor(data) {
-        super(data);
-    }
-    filter;
-    watch;
-    doInitialize = async (parameters) => {
-        const { subscribe, entityBinding, parentBinding } = this
-            ._meta;
-        const filter = (0, resolveTemplatedExpression_1.resolveTemplateExpression)(UiElement_1.UiElement.joinFilters(entityBinding, parentBinding), parameters);
-        if (!this.#isValidFilter(filter)) {
-            throw Error('Invalid filter');
-        }
-        this.filter = filter;
-        const grid = await this.resolver.read(this.filter);
-        if (!this.#isValidReadGrid(grid)) {
-            return;
-        }
-        this.#updateValue(grid);
-        if (subscribe) {
-            await this.#setupWatch(grid);
-        }
-    };
-    doClose = async () => {
-        return this.watch?.close();
-    };
-    getParameterList = () => {
-        const { entityBinding, parentBinding } = this
-            ._meta;
-        const parameters = [];
-        if (entityBinding) {
-            (0, resolveTemplatedExpression_1.replaceTemplateVariables)(entityBinding, (_, match) => {
-                parameters.push(match);
-                return '';
-            });
-        }
-        if (parentBinding) {
-            (0, resolveTemplatedExpression_1.replaceTemplateVariables)(parentBinding, (_, match) => {
-                parameters.push(match);
-                return '';
-            });
-        }
-        return parameters;
-    };
-    #isValidFilter = (filter) => {
-        try {
-            haystack_core_1.HFilter.parse(filter);
-        }
-        catch (e) {
-            console.error('Invalid filter: \n', this.filter, e);
-            return false;
-        }
-        return true;
-    };
-    #isValidReadGrid = (grid) => {
-        if (grid.isEmpty()) {
-            console.error('Empty grid result for query: \n', this.filter);
-            return false;
-        }
-        if (grid.length > 1) {
-            console.warn('More than 1 result for query: \n', this.filter);
-        }
-        return true;
-    };
-    #setupWatch = async (grid) => {
-        const { readTag, subscribePollRate, subscribe } = this
-            ._meta;
-        if (subscribe) {
-            this.watch = await this.resolver.makeWatch(this.#getWatchDisplayName(), grid);
-            const updateValue = () => this.#updateValue(this.watch?.grid);
-            // Update with the value received when opening the watch
-            updateValue();
-            // Configure polling options
-            this.watch.pollRate = subscribePollRate ?? haystack_nclient_1.DEFAULT_POLL_RATE_SECS;
-            this.watch.changed({
-                interests: [readTag],
-                callback: updateValue,
-            });
-        }
-    };
-    #updateValue = (grid) => {
-        const { readTag } = this._meta;
-        if (grid) {
-            this.value = grid[0]?.get(readTag);
-        }
-    };
-    #getWatchDisplayName = () => {
-        return `ResolvableElement Watch for ${this.name ?? this.filter}`;
-    };
-}
-exports.ResolvableTagElement = ResolvableTagElement;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolvableTagElement = void 0;
+const haystack_core_1 = require("haystack-core");
+const haystack_nclient_1 = require("haystack-nclient");
+const resolveTemplatedExpression_1 = require("../../resolveTemplatedExpression");
+const ResolvableValueElement_1 = require("../ResolvableValueElement");
+const UiElement_1 = require("../UiElement");
+/**
+ * Resolves to the value of a tag on a record and keeps it updated using a watch.
+ */
+class ResolvableTagElement extends ResolvableValueElement_1.ResolvableValueElement {
+    constructor(data) {
+        super(data);
+    }
+    filter;
+    watch;
+    doInitialize = async (parameters) => {
+        const { subscribe, entityBinding, parentBinding } = this
+            ._meta;
+        const filter = (0, resolveTemplatedExpression_1.resolveTemplateExpression)(UiElement_1.UiElement.joinFilters(entityBinding, parentBinding), parameters);
+        if (!this.#isValidFilter(filter)) {
+            throw Error('Invalid filter');
+        }
+        this.filter = filter;
+        const grid = await this.resolver.read(this.filter);
+        if (!this.#isValidReadGrid(grid)) {
+            return;
+        }
+        this.#updateValue(grid);
+        if (subscribe) {
+            await this.#setupWatch(grid);
+        }
+    };
+    doClose = async () => {
+        return this.watch?.close();
+    };
+    getParameterList = () => {
+        const { entityBinding, parentBinding } = this
+            ._meta;
+        const parameters = [];
+        if (entityBinding) {
+            (0, resolveTemplatedExpression_1.replaceTemplateVariables)(entityBinding, (_, match) => {
+                parameters.push(match);
+                return '';
+            });
+        }
+        if (parentBinding) {
+            (0, resolveTemplatedExpression_1.replaceTemplateVariables)(parentBinding, (_, match) => {
+                parameters.push(match);
+                return '';
+            });
+        }
+        return parameters;
+    };
+    #isValidFilter = (filter) => {
+        try {
+            haystack_core_1.HFilter.parse(filter);
+        }
+        catch (e) {
+            console.error('Invalid filter: \n', this.filter, e);
+            return false;
+        }
+        return true;
+    };
+    #isValidReadGrid = (grid) => {
+        if (grid.isEmpty()) {
+            console.error('Empty grid result for query: \n', this.filter);
+            return false;
+        }
+        if (grid.length > 1) {
+            console.warn('More than 1 result for query: \n', this.filter);
+        }
+        return true;
+    };
+    #setupWatch = async (grid) => {
+        const { readTag, subscribePollRate, subscribe } = this
+            ._meta;
+        if (subscribe) {
+            this.watch = await this.resolver.makeWatch(this.#getWatchDisplayName(), grid);
+            const updateValue = () => this.#updateValue(this.watch?.grid);
+            // Update with the value received when opening the watch
+            updateValue();
+            // Configure polling options
+            this.watch.pollRate = subscribePollRate ?? haystack_nclient_1.DEFAULT_POLL_RATE_SECS;
+            this.watch.changed({
+                interests: [readTag],
+                callback: updateValue,
+            });
+        }
+    };
+    #updateValue = (grid) => {
+        const { readTag } = this._meta;
+        if (grid) {
+            this.value = grid[0]?.get(readTag);
+        }
+    };
+    #getWatchDisplayName = () => {
+        return `ResolvableElement Watch for ${this.name ?? this.filter}`;
+    };
+}
+exports.ResolvableTagElement = ResolvableTagElement;
 //# sourceMappingURL=ResolvableTagElement.js.map

package/dist/resolvableElements/elements/tag/TagElementMeta.d.ts

@@ -1,12 +1,12 @@
-import { ResolvableValueElementMeta } from '../ResolvableValueElement';
-import { UiElementData, UiElementMeta } from '../UiElement';
-export interface UiElementTagMetaBase extends ResolvableValueElementMeta {
-    resolutionType: 'tag';
-    readTag: string;
-    parentBinding?: string;
-    entityBinding?: string;
-    subscribe?: boolean;
-    subscribePollRate?: number;
-}
-export declare const isResolvableTagElementData: (element: UiElementData) => element is UiElementData<UiElementTagMetaBase>;
-export declare const isResolvableTagMeta: (meta: UiElementMeta) => meta is UiElementTagMetaBase;
+import { ResolvableValueElementMeta } from '../ResolvableValueElement';
+import { UiElementData, UiElementMeta } from '../UiElement';
+export interface UiElementTagMetaBase extends ResolvableValueElementMeta {
+    resolutionType: 'tag';
+    readTag: string;
+    parentBinding?: string;
+    entityBinding?: string;
+    subscribe?: boolean;
+    subscribePollRate?: number;
+}
+export declare const isResolvableTagElementData: (element: UiElementData) => element is UiElementData<UiElementTagMetaBase>;
+export declare const isResolvableTagMeta: (meta: UiElementMeta) => meta is UiElementTagMetaBase;

package/dist/resolvableElements/elements/tag/TagElementMeta.js

@@ -1,15 +1,15 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isResolvableTagMeta = exports.isResolvableTagElementData = void 0;
-const isResolvableTagElementData = (element) => {
-    return !!element?._meta && (0, exports.isResolvableTagMeta)(element._meta);
-};
-exports.isResolvableTagElementData = isResolvableTagElementData;
-const isResolvableTagMeta = (meta) => {
-    return meta.resolutionType === 'tag';
-};
-exports.isResolvableTagMeta = isResolvableTagMeta;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isResolvableTagMeta = exports.isResolvableTagElementData = void 0;
+const isResolvableTagElementData = (element) => {
+    return !!element?._meta && (0, exports.isResolvableTagMeta)(element._meta);
+};
+exports.isResolvableTagElementData = isResolvableTagElementData;
+const isResolvableTagMeta = (meta) => {
+    return meta.resolutionType === 'tag';
+};
+exports.isResolvableTagMeta = isResolvableTagMeta;
 //# sourceMappingURL=TagElementMeta.js.map

package/dist/resolvableElements/interfacesGeneration/generateInterfaces.d.ts

@@ -1,17 +1,17 @@
-import { ResolvableSectionElement } from '../elements/section/ResolvableSectionElement';
-import { UiElementSectionMeta } from '../elements/section/SectionElementMeta';
-import { UiElementData } from '../elements/UiElement';
-export declare const generateInterfaces: (section: UiElementData<UiElementSectionMeta>) => string;
-/**
- * Class for generating typescript interfaces from a section data.
- */
-export declare class SectionInterfacesGenerator {
-    #private;
-    constructor(section: UiElementData<UiElementSectionMeta>);
-    sectionData: UiElementData<UiElementSectionMeta>;
-    output: string;
-    generate: () => string;
-    generateInterface(section: ResolvableSectionElement, indentation: number): void;
-    generateNamespace(section: ResolvableSectionElement<UiElementData<UiElementSectionMeta>>, indentation: number): void;
-}
-export declare function makeResolvableSectionElementMock(sectionData: UiElementData<UiElementSectionMeta>, name?: string): ResolvableSectionElement<UiElementData<UiElementSectionMeta>>;
+import { ResolvableSectionElement } from '../elements/section/ResolvableSectionElement';
+import { UiElementSectionMeta } from '../elements/section/SectionElementMeta';
+import { UiElementData } from '../elements/UiElement';
+export declare const generateInterfaces: (section: UiElementData<UiElementSectionMeta>) => string;
+/**
+ * Class for generating typescript interfaces from a section data.
+ */
+export declare class SectionInterfacesGenerator {
+    #private;
+    constructor(section: UiElementData<UiElementSectionMeta>);
+    sectionData: UiElementData<UiElementSectionMeta>;
+    output: string;
+    generate: () => string;
+    generateInterface(section: ResolvableSectionElement, indentation: number): void;
+    generateNamespace(section: ResolvableSectionElement<UiElementData<UiElementSectionMeta>>, indentation: number): void;
+}
+export declare function makeResolvableSectionElementMock(sectionData: UiElementData<UiElementSectionMeta>, name?: string): ResolvableSectionElement<UiElementData<UiElementSectionMeta>>;