@j2inn/resolvable-ui-elements 0.0.1-alpha.11

package/README.md

@@ -0,0 +1,22 @@
+# What is resolvable-ui-elements?
+The main goal of this library is to enhance the flexibility of the UI code written, by adding a layer that separates the queries and information used to interact with the backend from the UI code, moving it to a separated JSON file.
+
+The JSON file (typically called `elements.json`) can be generated from a spreadsheet used to simplify the data management for a project UI.
+
+
+## How do I get set up? ###
+To install this package run `npm i @j2inn/resolvable-ui-elements`
+
+## Where do I get more info? ###
+See: https://finproducts.atlassian.net/wiki/spaces/ECO/pages/32881311778/Element+Types
+
+## Codebase Structure ##
+
+    src
+    ├── resolvableElements
+    │   ├── elements                # Element classes implementation
+    │   ├── interfacesGeneration    # Code for generating interfaces from an elements.json file
+    │   ├── react                   # React hooks to use resolvable elements.
+    │   └── ...
+    └── ...
+

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { type FunctionResult } from './resolvableElements/elements/function/FunctionElement';
+export { isSectionData } from './resolvableElements/elements/section/SectionElementMeta';
+export { type ParametersOfSection, type ResolvedElementValue, type UiElementData, } from './resolvableElements/elements/UiElement';
+export * from './resolvableElements/react/useResolverContext';
+export * from './resolvableElements/react/useResolveSection';
+export * from './useCurrentUser';

package/dist/index.js

@@ -0,0 +1,32 @@
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSectionData = void 0;
+var SectionElementMeta_1 = require("./resolvableElements/elements/section/SectionElementMeta");
+Object.defineProperty(exports, "isSectionData", { enumerable: true, get: function () { return SectionElementMeta_1.isSectionData; } });
+//////////////////////////////////////////////////////////////////////////
+// React
+//////////////////////////////////////////////////////////////////////////
+__exportStar(require("./resolvableElements/react/useResolverContext"), exports);
+__exportStar(require("./resolvableElements/react/useResolveSection"), exports);
+//////////////////////////////////////////////////////////////////////////
+// Other
+//////////////////////////////////////////////////////////////////////////
+__exportStar(require("./useCurrentUser"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAMH,+FAAwF;AAA/E,mHAAA,aAAa,OAAA;AAMtB,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,gFAA6D;AAC7D,+EAA4D;AAC5D,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,mDAAgC"}

package/dist/resolvableElements/Resolver.d.ts

@@ -0,0 +1,18 @@
+import { HDict, HGrid } from 'haystack-core';
+import { Client, Watch } from 'haystack-nclient';
+export interface ResolverData {
+    client: Client;
+    user?: HDict;
+}
+/**
+ * Resolver is a mediator for the network interactions during the resolution process,
+ * in order to enable future optimizations.
+ */
+export declare class Resolver {
+    constructor({ client, user }: ResolverData);
+    client: Client;
+    user?: HDict;
+    read(filter: string): Promise<HGrid<HDict>>;
+    makeWatch(dis: string, grid: HGrid<HDict>): Promise<Watch>;
+    eval(expr: string): Promise<HGrid<HDict>>;
+}

package/dist/resolvableElements/Resolver.js

@@ -0,0 +1,29 @@
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resolver = void 0;
+/**
+ * Resolver is a mediator for the network interactions during the resolution process,
+ * in order to enable future optimizations.
+ */
+class Resolver {
+    constructor({ client, user }) {
+        this.client = client;
+        this.user = user;
+    }
+    client;
+    user;
+    async read(filter) {
+        return this.client.ext.read(filter);
+    }
+    async makeWatch(dis, grid) {
+        return this.client.ops.watch.make(dis, grid);
+    }
+    async eval(expr) {
+        return this.client.ext.eval(expr);
+    }
+}
+exports.Resolver = Resolver;
+//# sourceMappingURL=Resolver.js.map

package/dist/resolvableElements/Resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resolver.js","sourceRoot":"","sources":["../../src/resolvableElements/Resolver.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAUH;;;GAGG;AACH,MAAa,QAAQ;IACpB,YAAY,EAAE,MAAM,EAAE,IAAI,EAAgB;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACjB,CAAC;IAED,MAAM,CAAQ;IACd,IAAI,CAAQ;IAEZ,KAAK,CAAC,IAAI,CAAC,MAAc;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,IAAkB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAC7C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClC,CAAC;CACD;AApBD,4BAoBC"}

package/dist/resolvableElements/elements/ResolvableElement.d.ts

@@ -0,0 +1,14 @@
+import { HDict } from 'haystack-core';
+import { UiElement, UiElementConstructorData, UiElementData } from './UiElement';
+/**
+ * base class for elements that can be resolved
+ */
+export declare abstract class ResolvableElement<T extends UiElementData> extends UiElement<T> {
+    #private;
+    constructor(data: UiElementConstructorData<T>);
+    initialize: (parameters: HDict) => Promise<void>;
+    protected abstract doInitialize: (parameters: HDict) => Promise<void>;
+    close: () => Promise<void>;
+    protected abstract doClose: () => Promise<void>;
+    abstract getParameterList: () => string[];
+}

package/dist/resolvableElements/elements/ResolvableElement.js

@@ -0,0 +1,30 @@
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolvableElement = void 0;
+const UiElement_1 = require("./UiElement");
+/**
+ * base class for elements that can be resolved
+ */
+class ResolvableElement extends UiElement_1.UiElement {
+    constructor(data) {
+        super(data);
+    }
+    #initialized = false;
+    initialize = async (parameters) => {
+        if (this.isAccessAllowed() && !this.#initialized) {
+            this.#initialized = true;
+            return await this.doInitialize(parameters);
+        }
+    };
+    close = async () => {
+        if (this.#initialized) {
+            await this.doClose();
+            this.#initialized = false;
+        }
+    };
+}
+exports.ResolvableElement = ResolvableElement;
+//# sourceMappingURL=ResolvableElement.js.map

package/dist/resolvableElements/elements/ResolvableElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResolvableElement.js","sourceRoot":"","sources":["../../../src/resolvableElements/elements/ResolvableElement.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAGH,2CAAgF;AAEhF;;GAEG;AACH,MAAsB,iBAEpB,SAAQ,qBAAY;IACrB,YAAY,IAAiC;QAC5C,KAAK,CAAC,IAAI,CAAC,CAAA;IACZ,CAAC;IAED,YAAY,GAAG,KAAK,CAAA;IACpB,UAAU,GAAyC,KAAK,EAAE,UAAU,EAAE,EAAE;QACvE,IAAI,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACjD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;YACxB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;SAC1C;IACF,CAAC,CAAA;IAGD,KAAK,GAAwB,KAAK,IAAI,EAAE;QACvC,IAAI,IAAI,CAAC,YAAY,EAAE;YACtB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;YACpB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;SACzB;IACF,CAAC,CAAA;CAID;AAzBD,8CAyBC"}

package/dist/resolvableElements/elements/ResolvableValueElement.d.ts

@@ -0,0 +1,16 @@
+import { ResolvableElement } from './ResolvableElement';
+import { UiElementConstructorData, UiElementData, UiElementMeta } from './UiElement';
+export interface ResolvableValueElementMeta extends UiElementMeta {
+    resolutionType: string;
+    resolvedType: string;
+    defaultValue: string;
+}
+export declare const isResolvableValueElement: (element: UiElementData) => element is UiElementData<ResolvableValueElementMeta>;
+export declare const isResolvableValueElementMeta: (meta: UiElementMeta) => meta is ResolvableValueElementMeta;
+/**
+ * base class for leaf resolvable elements that are resolved into a value defined by the resolvedType property in the metadata
+ */
+export declare abstract class ResolvableValueElement<T extends UiElementData = UiElementData> extends ResolvableElement<T> {
+    #private;
+    constructor(data: UiElementConstructorData<T>);
+}

package/dist/resolvableElements/elements/ResolvableValueElement.js

@@ -0,0 +1,39 @@
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolvableValueElement = exports.isResolvableValueElementMeta = exports.isResolvableValueElement = void 0;
+const haystack_core_1 = require("haystack-core");
+const ResolvableElement_1 = require("./ResolvableElement");
+const isResolvableValueElement = (element) => {
+    return !!element?._meta && (0, exports.isResolvableValueElementMeta)(element._meta);
+};
+exports.isResolvableValueElement = isResolvableValueElement;
+const isResolvableValueElementMeta = (meta) => {
+    return (!!meta.resolutionType &&
+        !!meta.resolvedType);
+};
+exports.isResolvableValueElementMeta = isResolvableValueElementMeta;
+/**
+ * base class for leaf resolvable elements that are resolved into a value defined by the resolvedType property in the metadata
+ */
+class ResolvableValueElement extends ResolvableElement_1.ResolvableElement {
+    constructor(data) {
+        super(data);
+        this.#setDefaultValue();
+    }
+    #setDefaultValue() {
+        const { defaultValue } = this._meta;
+        if (defaultValue) {
+            try {
+                this.value = haystack_core_1.ZincReader.readValue(defaultValue);
+            }
+            catch (e) {
+                console.error('Failed to parse element default value from: ', JSON.stringify(this._meta), e);
+            }
+        }
+    }
+}
+exports.ResolvableValueElement = ResolvableValueElement;
+//# sourceMappingURL=ResolvableValueElement.js.map

package/dist/resolvableElements/elements/ResolvableValueElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResolvableValueElement.js","sourceRoot":"","sources":["../../../src/resolvableElements/elements/ResolvableValueElement.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,iDAA0C;AAC1C,2DAAuD;AAchD,MAAM,wBAAwB,GAAG,CACvC,OAAsB,EACiC,EAAE;IACzD,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,IAAA,oCAA4B,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AACvE,CAAC,CAAA;AAJY,QAAA,wBAAwB,4BAIpC;AAEM,MAAM,4BAA4B,GAAG,CAC3C,IAAmB,EACkB,EAAE;IACvC,OAAO,CACN,CAAC,CAA8B,IAAK,CAAC,cAAc;QACnD,CAAC,CAA8B,IAAK,CAAC,YAAY,CACjD,CAAA;AACF,CAAC,CAAA;AAPY,QAAA,4BAA4B,gCAOxC;AAED;;GAEG;AACH,MAAsB,sBAEpB,SAAQ,qCAAoB;IAC7B,YAAY,IAAiC;QAC5C,KAAK,CAAC,IAAI,CAAC,CAAA;QACX,IAAI,CAAC,gBAAgB,EAAE,CAAA;IACxB,CAAC;IAED,gBAAgB;QACf,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,KAAmC,CAAA;QAEjE,IAAI,YAAY,EAAE;YACjB,IAAI;gBACH,IAAI,CAAC,KAAK,GAAG,0BAAU,CAAC,SAAS,CAChC,YAAY,CAC0B,CAAA;aACvC;YAAC,OAAO,CAAC,EAAE;gBACX,OAAO,CAAC,KAAK,CACZ,8CAA8C,EAC9C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAC1B,CAAC,CACD,CAAA;aACD;SACD;IACF,CAAC;CACD;AAzBD,wDAyBC"}

package/dist/resolvableElements/elements/UiElement.d.ts

@@ -0,0 +1,40 @@
+import { HVal } from 'haystack-core';
+import { Resolver } from '../Resolver';
+export interface UiElementData<Meta extends UiElementMeta = UiElementMeta> {
+    _meta?: Meta;
+}
+export interface UiElementMeta {
+    access?: string[];
+}
+export declare type ResolvedElementValue<T extends UiElementData> = T extends {
+    _resolved?: unknown;
+} ? Required<T>['_resolved'] : unknown;
+export declare type ParametersOfSection<T extends UiElementData> = T extends {
+    _parameters?: Record<string, HVal>;
+} ? PartialExplicitUndefined<T['_parameters']> : undefined;
+export declare type PartialExplicitUndefined<T> = {
+    [P in keyof T]: T[P] | null | undefined;
+};
+export interface UiElementConstructorData<T extends UiElementData> {
+    resolver: Resolver;
+    onUpdate: (value: ResolvedElementValue<T> | undefined) => void;
+    element: T;
+    name?: string;
+}
+/**
+ * Base UiElement class
+ */
+export declare abstract class UiElement<T extends UiElementData = UiElementData> {
+    constructor({ name, element, resolver, onUpdate, }: UiElementConstructorData<T>);
+    resolver: Resolver;
+    _meta?: UiElementMeta;
+    name?: string;
+    toJSON(): Record<string, unknown>;
+    inspect(): void;
+    isAccessAllowed(): boolean;
+    protected _value?: ResolvedElementValue<T>;
+    get value(): ResolvedElementValue<T> | undefined;
+    set value(value: ResolvedElementValue<T> | undefined);
+    onUpdate: (value: ResolvedElementValue<T> | undefined) => void;
+}
+export declare function joinFilters(...filter: (string | undefined)[]): string;

package/dist/resolvableElements/elements/UiElement.js

@@ -0,0 +1,54 @@
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinFilters = exports.UiElement = void 0;
+const USER_ROLE_TAG_NAME = 'uiElementPermissions';
+/**
+ * Base UiElement class
+ */
+class UiElement {
+    constructor({ name, element, resolver, onUpdate, }) {
+        this._meta = element._meta;
+        this.name = name;
+        this.resolver = resolver;
+        this.onUpdate = onUpdate;
+    }
+    resolver;
+    _meta;
+    name;
+    toJSON() {
+        return { _meta: this._meta };
+    }
+    inspect() {
+        console.log(this);
+    }
+    isAccessAllowed() {
+        if (!this._meta?.access || isSuperuser(this.resolver.user)) {
+            return true;
+        }
+        const userRole = this.resolver.user?.get(USER_ROLE_TAG_NAME);
+        if (userRole) {
+            return this._meta.access.includes(userRole.value);
+        }
+        // If userRole is not defined return false.
+        return false;
+    }
+    _value;
+    get value() {
+        return this._value;
+    }
+    set value(value) {
+        this._value = value;
+        this.onUpdate(value);
+    }
+    onUpdate;
+}
+exports.UiElement = UiElement;
+function joinFilters(...filter) {
+    return filter.filter((filter) => filter).join(' and ');
+}
+exports.joinFilters = joinFilters;
+const isSuperuser = (user) => user?.get('userRole')?.value === 'su';
+//# sourceMappingURL=UiElement.js.map

package/dist/resolvableElements/elements/UiElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiElement.js","sourceRoot":"","sources":["../../../src/resolvableElements/elements/UiElement.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAKH,MAAM,kBAAkB,GAAG,sBAAsB,CAAA;AAiCjD;;GAEG;AACH,MAAsB,SAAS;IAC9B,YAAY,EACX,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,QAAQ,GACqB;QAC7B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IACzB,CAAC;IACD,QAAQ,CAAU;IAElB,KAAK,CAAgB;IAErB,IAAI,CAAS;IAEb,MAAM;QACL,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAA;IAC7B,CAAC;IACD,OAAO;QACN,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAClB,CAAC;IAED,eAAe;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC3D,OAAO,IAAI,CAAA;SACX;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAO,kBAAkB,CAAC,CAAA;QAClE,IAAI,QAAQ,EAAE;YACb,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;SACjD;QAED,2CAA2C;QAC3C,OAAO,KAAK,CAAA;IACb,CAAC;IAES,MAAM,CAA0B;IAE1C,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAA;IACnB,CAAC;IAED,IAAI,KAAK,CAAC,KAA0C;QACnD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACrB,CAAC;IACD,QAAQ,CAAsD;CAC9D;AAlDD,8BAkDC;AACD,SAAgB,WAAW,CAAC,GAAG,MAA8B;IAC5D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACvD,CAAC;AAFD,kCAEC;AAED,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CACpC,IAAI,EAAE,GAAG,CAAO,UAAU,CAAC,EAAE,KAAK,KAAK,IAAI,CAAA"}

package/dist/resolvableElements/elements/expr/ResolvableExprElement.d.ts

@@ -0,0 +1,14 @@
+import { HDict } from 'haystack-core';
+import { ResolvableValueElement } from '../ResolvableValueElement';
+import { UiElementConstructorData, UiElementData } from '../UiElement';
+/**
+ * Resolves to the result of an expression.
+ */
+export declare class ResolvableExprElement<T extends UiElementData> extends ResolvableValueElement<T> {
+    #private;
+    constructor(data: UiElementConstructorData<T>);
+    refreshes: number;
+    protected doInitialize: (parameters: HDict) => Promise<void>;
+    protected doClose: () => Promise<void>;
+    getParameterList: () => string[];
+}

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

@@ -0,0 +1,63 @@
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolvableExprElement = void 0;
+const haystack_core_1 = require("haystack-core");
+const haystack_units_1 = require("haystack-units");
+const resolveTemplatedExpression_1 = require("../../resolveTemplatedExpression");
+const ResolvableValueElement_1 = require("../ResolvableValueElement");
+/**
+ * Resolves to the result of an expression.
+ */
+class ResolvableExprElement extends ResolvableValueElement_1.ResolvableValueElement {
+    constructor(data) {
+        super(data);
+    }
+    refreshes = 0;
+    #timeout;
+    doInitialize = async (parameters) => {
+        this.#updateValue(parameters);
+    };
+    #updateValue = async (parameters) => {
+        const { expr, refreshAfter } = this._meta;
+        const resolvedExpression = (0, resolveTemplatedExpression_1.resolveTemplateExpression)(expr, parameters);
+        const grid = await this.resolver.eval(resolvedExpression);
+        if (grid.isError()) {
+            console.error('Empty grid result for expression: \n', resolvedExpression, grid.getError());
+            return;
+        }
+        const val = grid[0]?.get('val');
+        if (val) {
+            this.value = val;
+        }
+        else {
+            this.value = grid;
+        }
+        if (refreshAfter) {
+            this.#timeout = setTimeout(() => {
+                this.refreshes++;
+                this.#updateValue(parameters);
+            }, haystack_core_1.HNum.make(refreshAfter, haystack_units_1.second).convertTo(haystack_units_1.millisecond).value);
+        }
+    };
+    doClose = async () => {
+        if (this.#timeout) {
+            clearTimeout(this.#timeout);
+        }
+    };
+    getParameterList = () => {
+        const { expr } = this._meta;
+        const parameters = [];
+        if (expr) {
+            (0, resolveTemplatedExpression_1.replaceTemplateVariables)(expr, (_, match) => {
+                parameters.push(match);
+                return '';
+            });
+        }
+        return parameters;
+    };
+}
+exports.ResolvableExprElement = ResolvableExprElement;
+//# sourceMappingURL=ResolvableExprElement.js.map

package/dist/resolvableElements/elements/expr/ResolvableExprElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResolvableExprElement.js","sourceRoot":"","sources":["../../../../src/resolvableElements/elements/expr/ResolvableExprElement.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,iDAA2C;AAC3C,mDAAoD;AACpD,iFAGyC;AAEzC,sEAAkE;AAQlE;;GAEG;AACH,MAAa,qBAEX,SAAQ,+CAAyB;IAClC,YAAY,IAAiC;QAC5C,KAAK,CAAC,IAAI,CAAC,CAAA;IACZ,CAAC;IAED,SAAS,GAAG,CAAC,CAAA;IACb,QAAQ,CAAS;IAEP,YAAY,GAAG,KAAK,EAAE,UAAiB,EAAiB,EAAE;QACnE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;IAC9B,CAAC,CAAA;IAED,YAAY,GAAG,KAAK,EAAE,UAAiB,EAAiB,EAAE;QACzD,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,KAAkC,CAAA;QAEtE,MAAM,kBAAkB,GAAG,IAAA,sDAAyB,EAAC,IAAI,EAAE,UAAU,CAAC,CAAA;QAEtE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QAEzD,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;YACnB,OAAO,CAAC,KAAK,CACZ,sCAAsC,EACtC,kBAAkB,EAClB,IAAI,CAAC,QAAQ,EAAE,CACf,CAAA;YACD,OAAM;SACN;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAA;QAE/B,IAAI,GAAG,EAAE;YACR,IAAI,CAAC,KAAK,GAAG,GAAyC,CAAA;SACtD;aAAM;YACN,IAAI,CAAC,KAAK,GAAG,IAA0C,CAAA;SACvD;QAED,IAAI,YAAY,EAAE;YACjB,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC/B,IAAI,CAAC,SAAS,EAAE,CAAA;gBAChB,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;YAC9B,CAAC,EAAE,oBAAI,CAAC,IAAI,CAAC,YAAY,EAAE,uBAAM,CAAC,CAAC,SAAS,CAAC,4BAAW,CAAC,CAAC,KAAK,CAAsB,CAAA;SACrF;IACF,CAAC,CAAA;IAES,OAAO,GAAG,KAAK,IAAmB,EAAE;QAC7C,IAAI,IAAI,CAAC,QAAQ,EAAE;YAClB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;SAC3B;IACF,CAAC,CAAA;IAED,gBAAgB,GAAmB,GAAG,EAAE;QACvC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAkC,CAAA;QAExD,MAAM,UAAU,GAAa,EAAE,CAAA;QAE/B,IAAI,IAAI,EAAE;YACT,IAAA,qDAAwB,EAAC,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;gBAC3C,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBACtB,OAAO,EAAE,CAAA;YACV,CAAC,CAAC,CAAA;SACF;QAED,OAAO,UAAU,CAAA;IAClB,CAAC,CAAA;CACD;AAlED,sDAkEC"}

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

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

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

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

package/dist/resolvableElements/elements/expr/ResolvableExprElementMeta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResolvableExprElementMeta.js","sourceRoot":"","sources":["../../../../src/resolvableElements/elements/expr/ResolvableExprElementMeta.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAWI,MAAM,2BAA2B,GAAG,CAC1C,OAAsB,EACgC,EAAE;IACxD,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,IAAA,mCAA2B,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;AACvE,CAAC,CAAA;AAJY,QAAA,2BAA2B,+BAIvC;AAEM,MAAM,2BAA2B,GAAG,CAC1C,IAAmB,EACiB,EAAE;IACtC,OAAQ,IAAkC,CAAC,cAAc,KAAK,MAAM,CAAA;AACrE,CAAC,CAAA;AAJY,QAAA,2BAA2B,+BAIvC"}

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

@@ -0,0 +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 declare type FunctionResult = (parameters: Parameters) => Promise<HGrid>;
+export declare 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/resolvableElements/elements/function/FunctionElement.js

@@ -0,0 +1,37 @@
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeParametersDict = exports.FunctionElement = void 0;
+const haystack_core_1 = require("haystack-core");
+const resolveTemplatedExpression_1 = require("../../resolveTemplatedExpression");
+const UiElement_1 = require("../UiElement");
+/**
+ * Resolves to a function that can be called to achieve side effects.
+ */
+class FunctionElement extends UiElement_1.UiElement {
+    constructor(data) {
+        super(data);
+        this.value = this.#buildFunction();
+    }
+    #buildFunction = () => {
+        const { expr } = this._meta;
+        return async (parameters) => {
+            const resolvedExpression = (0, resolveTemplatedExpression_1.resolveTemplateExpression)(expr, (0, exports.makeParametersDict)(parameters));
+            return await this.resolver.eval(resolvedExpression);
+        };
+    };
+}
+exports.FunctionElement = FunctionElement;
+const makeParametersDict = (parameters) => {
+    if (!parameters) {
+        return haystack_core_1.HDict.make();
+    }
+    if (parameters instanceof haystack_core_1.HDict) {
+        return parameters;
+    }
+    return haystack_core_1.HDict.make(Object.fromEntries(Object.entries(parameters).filter(([, v]) => v != null)));
+};
+exports.makeParametersDict = makeParametersDict;
+//# sourceMappingURL=FunctionElement.js.map

package/dist/resolvableElements/elements/function/FunctionElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionElement.js","sourceRoot":"","sources":["../../../../src/resolvableElements/elements/function/FunctionElement.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,iDAAgF;AAChF,iFAA4E;AAE5E,4CAKqB;AAGrB;;GAEG;AACH,MAAa,eAAyC,SAAQ,qBAAY;IACzE,YAAY,IAAiC;QAC5C,KAAK,CAAC,IAAI,CAAC,CAAA;QACX,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,cAAc,EAAwC,CAAA;IACzE,CAAC;IAED,cAAc,GAAG,GAAmB,EAAE;QACrC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAA4B,CAAA;QAElD,OAAO,KAAK,EAAE,UAAU,EAAE,EAAE;YAC3B,MAAM,kBAAkB,GAAG,IAAA,sDAAyB,EACnD,IAAI,EACJ,IAAA,0BAAkB,EAAC,UAAU,CAAC,CAC9B,CAAA;YAED,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QACpD,CAAC,CAAA;IACF,CAAC,CAAA;CACD;AAlBD,0CAkBC;AAUM,MAAM,kBAAkB,GAAG,CACjC,UAIY,EACJ,EAAE;IACV,IAAI,CAAC,UAAU,EAAE;QAChB,OAAO,qBAAK,CAAC,IAAI,EAAE,CAAA;KACnB;IACD,IAAI,UAAU,YAAY,qBAAK,EAAE;QAChC,OAAO,UAAU,CAAA;KACjB;IAED,OAAO,qBAAK,CAAC,IAAI,CAChB,MAAM,CAAC,WAAW,CACjB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CACvD,CACD,CAAA;AACF,CAAC,CAAA;AAnBY,QAAA,kBAAkB,sBAmB9B"}

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

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

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

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

package/dist/resolvableElements/elements/function/FunctionElementMeta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionElementMeta.js","sourceRoot":"","sources":["../../../../src/resolvableElements/elements/function/FunctionElementMeta.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AASI,MAAM,qBAAqB,GAAG,CACpC,OAAsB,EAC0B,EAAE;IAClD,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,IAAA,6BAAqB,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAChE,CAAC,CAAA;AAJY,QAAA,qBAAqB,yBAIjC;AAEM,MAAM,qBAAqB,GAAG,CACpC,IAAmB,EACW,EAAE;IAChC,OAAQ,IAA4B,CAAC,cAAc,KAAK,UAAU,CAAA;AACnE,CAAC,CAAA;AAJY,QAAA,qBAAqB,yBAIjC"}

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

@@ -0,0 +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;

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

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

package/dist/resolvableElements/elements/list/ListElementMeta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListElementMeta.js","sourceRoot":"","sources":["../../../../src/resolvableElements/elements/list/ListElementMeta.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAcI,MAAM,2BAA2B,GAAG,CAC1C,OAAsB,EACgC,EAAE;IACxD,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,IAAA,mCAA2B,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AACtE,CAAC,CAAA;AAJY,QAAA,2BAA2B,+BAIvC;AAEM,MAAM,2BAA2B,GAAG,CAC1C,IAAmB,EACiB,EAAE;IACtC,OAAQ,IAAkC,CAAC,cAAc,KAAK,MAAM,CAAA;AACrE,CAAC,CAAA;AAJY,QAAA,2BAA2B,+BAIvC"}

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

@@ -0,0 +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[];
+}