@j2inn/resolvable-ui-elements 1.1.3 → 2.0.0

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

@@ -1,37 +1,37 @@
-/*
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
- */
-import { makeParametersDict } from '../function/FunctionElement';
-import { ResolvableSectionElement } from './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.
- */
-export async function resolveSection(resolver, sectionData, parameters) {
-    const parametersDict = makeParametersDict(parameters);
-    if (areParametersValid(parameters)) {
-        const sectionElement = new ResolvableSectionElement({
-            element: sectionData,
-            resolver,
-            onUpdate: () => {
-                return;
-            },
-        });
-        await sectionElement
-            .initialize(parametersDict)
-            .finally(() => sectionElement?.close());
-        return sectionElement.value;
-    }
-    return undefined;
-}
-export const areParametersValid = (parameters) => {
-    if (parameters &&
-        Object.entries(parameters).some(([, value]) => value == null)) {
-        return false;
-    }
-    return true;
-};
+/*
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
+ */
+import { makeParametersDict } from '../function/FunctionElement';
+import { ResolvableSectionElement } from './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.
+ */
+export async function resolveSection(resolver, sectionData, parameters) {
+    const parametersDict = makeParametersDict(parameters);
+    if (areParametersValid(parameters)) {
+        const sectionElement = new ResolvableSectionElement({
+            element: sectionData,
+            resolver,
+            onUpdate: () => {
+                return;
+            },
+        });
+        await sectionElement
+            .initialize(parametersDict)
+            .finally(() => sectionElement?.close());
+        return sectionElement.value;
+    }
+    return undefined;
+}
+export const areParametersValid = (parameters) => {
+    if (parameters &&
+        Object.entries(parameters).some(([, value]) => value == null)) {
+        return false;
+    }
+    return true;
+};
 //# sourceMappingURL=resolveSection.js.map

package/dist_es/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_es/resolvableElements/elements/tag/ResolvableTagElement.js

@@ -1,102 +1,102 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import { HFilter } from 'haystack-core';
-import { DEFAULT_POLL_RATE_SECS } from 'haystack-nclient';
-import { replaceTemplateVariables, resolveTemplateExpression, } from '../../resolveTemplatedExpression';
-import { ResolvableValueElement } from '../ResolvableValueElement';
-import { UiElement, } from '../UiElement';
-/**
- * Resolves to the value of a tag on a record and keeps it updated using a watch.
- */
-export class ResolvableTagElement extends ResolvableValueElement {
-    constructor(data) {
-        super(data);
-    }
-    filter;
-    watch;
-    doInitialize = async (parameters) => {
-        const { subscribe, entityBinding, parentBinding } = this
-            ._meta;
-        const filter = resolveTemplateExpression(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) {
-            replaceTemplateVariables(entityBinding, (_, match) => {
-                parameters.push(match);
-                return '';
-            });
-        }
-        if (parentBinding) {
-            replaceTemplateVariables(parentBinding, (_, match) => {
-                parameters.push(match);
-                return '';
-            });
-        }
-        return parameters;
-    };
-    #isValidFilter = (filter) => {
-        try {
-            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 ?? 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}`;
-    };
-}
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import { HFilter } from 'haystack-core';
+import { DEFAULT_POLL_RATE_SECS } from 'haystack-nclient';
+import { replaceTemplateVariables, resolveTemplateExpression, } from '../../resolveTemplatedExpression';
+import { ResolvableValueElement } from '../ResolvableValueElement';
+import { UiElement, } from '../UiElement';
+/**
+ * Resolves to the value of a tag on a record and keeps it updated using a watch.
+ */
+export class ResolvableTagElement extends ResolvableValueElement {
+    constructor(data) {
+        super(data);
+    }
+    filter;
+    watch;
+    doInitialize = async (parameters) => {
+        const { subscribe, entityBinding, parentBinding } = this
+            ._meta;
+        const filter = resolveTemplateExpression(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) {
+            replaceTemplateVariables(entityBinding, (_, match) => {
+                parameters.push(match);
+                return '';
+            });
+        }
+        if (parentBinding) {
+            replaceTemplateVariables(parentBinding, (_, match) => {
+                parameters.push(match);
+                return '';
+            });
+        }
+        return parameters;
+    };
+    #isValidFilter = (filter) => {
+        try {
+            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 ?? 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}`;
+    };
+}
 //# sourceMappingURL=ResolvableTagElement.js.map

package/dist_es/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_es/resolvableElements/elements/tag/TagElementMeta.js

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

package/dist_es/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>>;

package/dist_es/resolvableElements/interfacesGeneration/generateInterfaces.js

@@ -1,40 +1,40 @@
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-import { HDict } from 'haystack-core';
-import { Client } from 'haystack-nclient';
-import { isResolvableValueElementMeta } from '../elements/ResolvableValueElement';
-import { isChildUnresolvedSection, ResolvableSectionElement, } from '../elements/section/ResolvableSectionElement';
-import { Resolver } from '../Resolver';
-const ROOT_NAME = 'UiElementRoot';
-const ELEMENT_INTERFACE_NAME = 'UiElementData';
-export const generateInterfaces = (section) => {
-    return new SectionInterfacesGenerator(section).generate();
-};
-/**
- * Class for generating typescript interfaces from a section data.
- */
-export class SectionInterfacesGenerator {
-    constructor(section) {
-        this.sectionData = section;
-    }
-    sectionData;
-    output = '';
-    #out = (str, indentation = 0) => {
-        this.output += this.#indent(indentation) + str + '\n';
-    };
-    #indent(indentation = 0) {
-        return '\t'.repeat(indentation);
-    }
-    generate = () => {
-        this.#generateImports();
-        const section = makeResolvableSectionElementMock(this.sectionData);
-        this.#generateSectionDefinition(section);
-        const result = this.output;
-        this.output = '';
-        return result;
-    };
-    #generateImports() {
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+import { HDict } from 'haystack-core';
+import { Client } from 'haystack-nclient';
+import { isResolvableValueElementMeta } from '../elements/ResolvableValueElement';
+import { isChildUnresolvedSection, ResolvableSectionElement, } from '../elements/section/ResolvableSectionElement';
+import { Resolver } from '../Resolver';
+const ROOT_NAME = 'UiElementRoot';
+const ELEMENT_INTERFACE_NAME = 'UiElementData';
+export const generateInterfaces = (section) => {
+    return new SectionInterfacesGenerator(section).generate();
+};
+/**
+ * Class for generating typescript interfaces from a section data.
+ */
+export class SectionInterfacesGenerator {
+    constructor(section) {
+        this.sectionData = section;
+    }
+    sectionData;
+    output = '';
+    #out = (str, indentation = 0) => {
+        this.output += this.#indent(indentation) + str + '\n';
+    };
+    #indent(indentation = 0) {
+        return '\t'.repeat(indentation);
+    }
+    generate = () => {
+        this.#generateImports();
+        const section = makeResolvableSectionElementMock(this.sectionData);
+        this.#generateSectionDefinition(section);
+        const result = this.output;
+        this.output = '';
+        return result;
+    };
+    #generateImports() {
         this.#out(`/* eslint-disable @typescript-eslint/no-namespace */
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 
@@ -53,95 +53,95 @@ export const UI_ELEMENTS = json as UiElementRoot
 //////////////////////////////////////////////////////////////////////////
 // Interfaces
 //////////////////////////////////////////////////////////////////////////
-`);
-    }
-    #generateSectionDefinition(section, indentation = 0) {
-        this.generateInterface(section, indentation);
-        if (hasChildrenSections(section)) {
-            this.generateNamespace(section, indentation);
-        }
-    }
-    generateInterface(section, indentation) {
-        const name = section.name ?? ROOT_NAME;
-        this.#out(`export interface ${capitalize(name)} extends UiElementData {`, indentation);
-        const parameters = section.getParameterList();
-        if (parameters.length > 0) {
-            this.#generateParametersProperty(parameters, indentation + 1);
-        }
-        this.#generateResolvedProperty(section, indentation + 1);
-        section.children.forEach((child) => this.#out(isChildUnresolvedSection(child)
-            ? `${child[0]}: ${capitalize(name)}.${capitalize(child[0] ?? '')}`
-            : `${child.name}: ${ELEMENT_INTERFACE_NAME}`, indentation + 1));
-        this.#out(`}`, indentation);
-    }
-    #generateParametersProperty(parameters, indentation) {
-        this.#out(`_parameters?: {`, indentation);
-        parameters.forEach((param) => this.#out(`${param}: HCore.HVal`, indentation + 1));
-        this.#out(`}`, indentation);
-    }
-    #generateResolvedProperty(section, indentation) {
-        const name = section.name ?? ROOT_NAME;
-        if (section.children.length > 0) {
-            this.#out('_resolved?: {', indentation);
-            section.children.forEach((child) => this.#out(isChildUnresolvedSection(child)
-                ? `${child[0]}?: ${capitalize(name)}.${capitalize(child[0] ?? '')}`
-                : `${child.name}?: ${getResolvedType(child)}`, indentation + 1));
-            this.#out('}', indentation);
-        }
-        else {
-            this.#out(`_resolved?: Record<string, unknown>`, indentation);
-        }
-    }
-    generateNamespace(section, indentation) {
-        const name = section.name ?? ROOT_NAME;
-        this.#out(`export namespace ${capitalize(name)} {`, indentation);
-        section.children
-            .filter((child) => isChildUnresolvedSection(child))
-            .forEach((child) => {
-            if (isChildUnresolvedSection(child)) {
-                const section = makeResolvableSectionElementMock(child[1], child[0]);
-                this.#generateSectionDefinition(section, indentation + 1);
-            }
-        });
-        this.#out(`}`, indentation);
-    }
-}
-export function makeResolvableSectionElementMock(sectionData, name) {
-    return new ResolvableSectionElement({
-        name,
-        element: sectionData,
-        onUpdate: () => {
-            return;
-        },
-        resolver: new Resolver({
-            client: makeMockedClient(),
-            user: HDict.make({ userRole: 'su' }),
-        }),
-    });
-}
-function makeMockedClient() {
-    return new Client({
-        base: new URL('http://localhost:8080'),
-        fetch: () => new Promise(() => {
-            return new Response();
-        }),
-    });
-}
-function capitalize(str) {
-    return str.charAt(0)?.toUpperCase() + str.substring(1);
-}
-function getResolvedType(child) {
-    if (child._meta && isResolvableValueElementMeta(child._meta)) {
-        return child._meta.resolvedType.startsWith('H')
-            ? 'HCore.' + child._meta.resolvedType
-            : child._meta.resolvedType;
-    }
-    else {
-        return 'unknown';
-    }
-}
-function hasChildrenSections(section) {
-    return (section.children.filter((child) => isChildUnresolvedSection(child))
-        .length > 0);
-}
+`);
+    }
+    #generateSectionDefinition(section, indentation = 0) {
+        this.generateInterface(section, indentation);
+        if (hasChildrenSections(section)) {
+            this.generateNamespace(section, indentation);
+        }
+    }
+    generateInterface(section, indentation) {
+        const name = section.name ?? ROOT_NAME;
+        this.#out(`export interface ${capitalize(name)} extends UiElementData {`, indentation);
+        const parameters = section.getParameterList();
+        if (parameters.length > 0) {
+            this.#generateParametersProperty(parameters, indentation + 1);
+        }
+        this.#generateResolvedProperty(section, indentation + 1);
+        section.children.forEach((child) => this.#out(isChildUnresolvedSection(child)
+            ? `${child[0]}: ${capitalize(name)}.${capitalize(child[0] ?? '')}`
+            : `${child.name}: ${ELEMENT_INTERFACE_NAME}`, indentation + 1));
+        this.#out(`}`, indentation);
+    }
+    #generateParametersProperty(parameters, indentation) {
+        this.#out(`_parameters?: {`, indentation);
+        parameters.forEach((param) => this.#out(`${param}: HCore.HVal`, indentation + 1));
+        this.#out(`}`, indentation);
+    }
+    #generateResolvedProperty(section, indentation) {
+        const name = section.name ?? ROOT_NAME;
+        if (section.children.length > 0) {
+            this.#out('_resolved?: {', indentation);
+            section.children.forEach((child) => this.#out(isChildUnresolvedSection(child)
+                ? `${child[0]}?: ${capitalize(name)}.${capitalize(child[0] ?? '')}`
+                : `${child.name}?: ${getResolvedType(child)}`, indentation + 1));
+            this.#out('}', indentation);
+        }
+        else {
+            this.#out(`_resolved?: Record<string, unknown>`, indentation);
+        }
+    }
+    generateNamespace(section, indentation) {
+        const name = section.name ?? ROOT_NAME;
+        this.#out(`export namespace ${capitalize(name)} {`, indentation);
+        section.children
+            .filter((child) => isChildUnresolvedSection(child))
+            .forEach((child) => {
+            if (isChildUnresolvedSection(child)) {
+                const section = makeResolvableSectionElementMock(child[1], child[0]);
+                this.#generateSectionDefinition(section, indentation + 1);
+            }
+        });
+        this.#out(`}`, indentation);
+    }
+}
+export function makeResolvableSectionElementMock(sectionData, name) {
+    return new ResolvableSectionElement({
+        name,
+        element: sectionData,
+        onUpdate: () => {
+            return;
+        },
+        resolver: new Resolver({
+            client: makeMockedClient(),
+            user: HDict.make({ userRole: 'su' }),
+        }),
+    });
+}
+function makeMockedClient() {
+    return new Client({
+        base: new URL('http://localhost:8080'),
+        fetch: () => new Promise(() => {
+            return new Response();
+        }),
+    });
+}
+function capitalize(str) {
+    return str.charAt(0)?.toUpperCase() + str.substring(1);
+}
+function getResolvedType(child) {
+    if (child._meta && isResolvableValueElementMeta(child._meta)) {
+        return child._meta.resolvedType.startsWith('H')
+            ? 'HCore.' + child._meta.resolvedType
+            : child._meta.resolvedType;
+    }
+    else {
+        return 'unknown';
+    }
+}
+function hasChildrenSections(section) {
+    return (section.children.filter((child) => isChildUnresolvedSection(child))
+        .length > 0);
+}
 //# sourceMappingURL=generateInterfaces.js.map