@j2inn/resolvable-ui-elements 2.0.0 → 2.1.0-beta.0

package/dist/index.d.ts

@@ -1,12 +1,12 @@
-export * from './resolvableElements/elements/section/resolveSection';
-export * from './resolvableElements/Resolver';
-export { type ResolvableValueElementMeta } from './resolvableElements/elements/ResolvableValueElement';
-export { type UiElementData } from './resolvableElements/elements/UiElement';
-export { type ResolvableExprElementMeta } from './resolvableElements/elements/expr/ResolvableExprElementMeta';
-export { type FunctionResult } from './resolvableElements/elements/function/FunctionElement';
-export { isSectionData, type ParametersOfSection, type ResolvedSection, } from './resolvableElements/elements/section/SectionElementMeta';
-export { resolveTemplateExpression } from './resolvableElements/resolveTemplatedExpression';
-export * from './resolvableElements/react/SectionChecker';
-export * from './resolvableElements/react/useResolveSection';
-export * from './resolvableElements/react/useResolverContext';
-export * from './useCurrentUser';
+export * from './resolvableElements/elements/section/resolveSection';
+export * from './resolvableElements/Resolver';
+export { type ResolvableValueElementMeta } from './resolvableElements/elements/ResolvableValueElement';
+export { type UiElementData } from './resolvableElements/elements/UiElement';
+export { type ResolvableExprElementMeta } from './resolvableElements/elements/expr/ResolvableExprElementMeta';
+export { type FunctionResult } from './resolvableElements/elements/function/FunctionElement';
+export { isSectionData, type ParametersOfSection, type ResolvedSection, } from './resolvableElements/elements/section/SectionElementMeta';
+export { resolveTemplateExpression } from './resolvableElements/resolveTemplatedExpression';
+export * from './resolvableElements/react/SectionChecker';
+export * from './resolvableElements/react/useResolveSection';
+export * from './resolvableElements/react/useResolverContext';
+export * from './useCurrentUser';

package/dist/index.js

@@ -1,40 +1,40 @@
-"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.resolveTemplateExpression = exports.isSectionData = void 0;
-//////////////////////////////////////////////////////////////////////////
-// Elements
-//////////////////////////////////////////////////////////////////////////
-__exportStar(require("./resolvableElements/elements/section/resolveSection"), exports);
-__exportStar(require("./resolvableElements/Resolver"), exports);
-var SectionElementMeta_1 = require("./resolvableElements/elements/section/SectionElementMeta");
-Object.defineProperty(exports, "isSectionData", { enumerable: true, get: function () { return SectionElementMeta_1.isSectionData; } });
-var resolveTemplatedExpression_1 = require("./resolvableElements/resolveTemplatedExpression");
-Object.defineProperty(exports, "resolveTemplateExpression", { enumerable: true, get: function () { return resolveTemplatedExpression_1.resolveTemplateExpression; } });
-//////////////////////////////////////////////////////////////////////////
-// React
-//////////////////////////////////////////////////////////////////////////
-__exportStar(require("./resolvableElements/react/SectionChecker"), exports);
-__exportStar(require("./resolvableElements/react/useResolveSection"), exports);
-__exportStar(require("./resolvableElements/react/useResolverContext"), exports);
-//////////////////////////////////////////////////////////////////////////
-// Other
-//////////////////////////////////////////////////////////////////////////
-__exportStar(require("./useCurrentUser"), exports);
+"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.resolveTemplateExpression = exports.isSectionData = void 0;
+//////////////////////////////////////////////////////////////////////////
+// Elements
+//////////////////////////////////////////////////////////////////////////
+__exportStar(require("./resolvableElements/elements/section/resolveSection"), exports);
+__exportStar(require("./resolvableElements/Resolver"), exports);
+var SectionElementMeta_1 = require("./resolvableElements/elements/section/SectionElementMeta");
+Object.defineProperty(exports, "isSectionData", { enumerable: true, get: function () { return SectionElementMeta_1.isSectionData; } });
+var resolveTemplatedExpression_1 = require("./resolvableElements/resolveTemplatedExpression");
+Object.defineProperty(exports, "resolveTemplateExpression", { enumerable: true, get: function () { return resolveTemplatedExpression_1.resolveTemplateExpression; } });
+//////////////////////////////////////////////////////////////////////////
+// React
+//////////////////////////////////////////////////////////////////////////
+__exportStar(require("./resolvableElements/react/SectionChecker"), exports);
+__exportStar(require("./resolvableElements/react/useResolveSection"), exports);
+__exportStar(require("./resolvableElements/react/useResolverContext"), exports);
+//////////////////////////////////////////////////////////////////////////
+// Other
+//////////////////////////////////////////////////////////////////////////
+__exportStar(require("./useCurrentUser"), exports);
 //# sourceMappingURL=index.js.map

package/dist/resolvableElements/Resolver.d.ts

@@ -1,47 +1,47 @@
-import { HDict, HGrid } from 'haystack-core';
-import { Client, Watch } from 'haystack-nclient';
-export declare const DEFAULT_USER_ROLE_TAG_NAME = "uiElementPermissions";
-export interface ResolverData {
-    /**
-     * Haystack client for network communication
-     */
-    client: Client;
-    /**
-     * Current user dict, used to check permissions
-     */
-    user?: HDict;
-    /**
-     * Name of the tag that is expected on the user dict to define its role
-     */
-    userRoleTagName?: string;
-    /**
-     * Function name to be used for expressions eval,
-     * used to enable custom backend permission check using elements path
-     * @example
-     * customEval(\`page/section/elementName\`, parametersDict)
-     */
-    evalFuncName?: string;
-}
-/**
- * Resolver is a mediator for the network interactions during the resolution process,
- * in order to enable future optimizations and extra features
- */
-export declare class Resolver implements ResolverData {
-    constructor({ client, user, userRoleTagName, evalFuncName, }: ResolverData);
-    client: Client;
-    user?: HDict;
-    userRoleTagName?: string;
-    evalFuncName?: string;
-    read(filter: string): Promise<HGrid<HDict>>;
-    makeWatch(dis: string, grid: HGrid<HDict>): Promise<Watch>;
-    /**
-     * Eval an expression using either the provided path or otherwse directly the expression
-     * Providing the path allows for whitelisting of certain functions to specific user roles
-     */
-    evalExprElement(expr: string, parameters: HDict, path?: string): Promise<HGrid<HDict>>;
-    private _buildExpression;
-    /**
-     * Evaluate an expression
-     */
-    private _eval;
-}
+import { HDict, HGrid } from 'haystack-core';
+import { Client, Watch } from 'haystack-nclient';
+export declare const DEFAULT_USER_ROLE_TAG_NAME = "uiElementPermissions";
+export interface ResolverData {
+    /**
+     * Haystack client for network communication
+     */
+    client: Client;
+    /**
+     * Current user dict, used to check permissions
+     */
+    user?: HDict;
+    /**
+     * Name of the tag that is expected on the user dict to define its role
+     */
+    userRoleTagName?: string;
+    /**
+     * Function name to be used for expressions eval,
+     * used to enable custom backend permission check using elements path
+     * @example
+     * customEval(\`page/section/elementName\`, parametersDict)
+     */
+    evalFuncName?: string;
+}
+/**
+ * Resolver is a mediator for the network interactions during the resolution process,
+ * in order to enable future optimizations and extra features
+ */
+export declare class Resolver implements ResolverData {
+    constructor({ client, user, userRoleTagName, evalFuncName, }: ResolverData);
+    client: Client;
+    user?: HDict;
+    userRoleTagName?: string;
+    evalFuncName?: string;
+    read(filter: string): Promise<HGrid<HDict>>;
+    makeWatch(dis: string, grid: HGrid<HDict>): Promise<Watch>;
+    /**
+     * Eval an expression using either the provided path or otherwse directly the expression
+     * Providing the path allows for whitelisting of certain functions to specific user roles
+     */
+    evalExprElement(expr: string, parameters: HDict, path?: string): Promise<HGrid<HDict>>;
+    private _buildExpression;
+    /**
+     * Evaluate an expression
+     */
+    private _eval;
+}

package/dist/resolvableElements/Resolver.js

@@ -1,58 +1,58 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Resolver = exports.DEFAULT_USER_ROLE_TAG_NAME = void 0;
-const haystack_core_1 = require("haystack-core");
-const resolveTemplatedExpression_1 = require("./resolveTemplatedExpression");
-exports.DEFAULT_USER_ROLE_TAG_NAME = 'uiElementPermissions';
-/**
- * Resolver is a mediator for the network interactions during the resolution process,
- * in order to enable future optimizations and extra features
- */
-class Resolver {
-    constructor({ client, user, userRoleTagName = exports.DEFAULT_USER_ROLE_TAG_NAME, evalFuncName, }) {
-        this.client = client;
-        this.user = user;
-        this.userRoleTagName = userRoleTagName;
-        this.evalFuncName = evalFuncName;
-    }
-    client;
-    user;
-    userRoleTagName;
-    evalFuncName;
-    read(filter) {
-        return this.client.ext.read(filter);
-    }
-    makeWatch(dis, grid) {
-        return this.client.ops.watch.make(dis, grid);
-    }
-    /**
-     * Eval an expression using either the provided path or otherwse directly the expression
-     * Providing the path allows for whitelisting of certain functions to specific user roles
-     */
-    evalExprElement(expr, parameters, path) {
-        return this._eval(this._buildExpression(expr, parameters, path));
-    }
-    _buildExpression(expr, parameters, path) {
-        if (!!path && this.evalFuncName) {
-            return `${this.evalFuncName}(${haystack_core_1.HUri.make(path).toAxon()}, ${parameters.toAxon()})`;
-        }
-        else {
-            return (0, resolveTemplatedExpression_1.resolveTemplateExpression)(expr, parameters);
-        }
-    }
-    /**
-     * Evaluate an expression
-     */
-    async _eval(expr) {
-        const grid = await this.client.ext.eval(expr);
-        if (grid.isError()) {
-            console.error('Empty grid result for expression: \n', expr, grid.getError());
-        }
-        return grid;
-    }
-}
-exports.Resolver = Resolver;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resolver = exports.DEFAULT_USER_ROLE_TAG_NAME = void 0;
+const haystack_core_1 = require("haystack-core");
+const resolveTemplatedExpression_1 = require("./resolveTemplatedExpression");
+exports.DEFAULT_USER_ROLE_TAG_NAME = 'uiElementPermissions';
+/**
+ * Resolver is a mediator for the network interactions during the resolution process,
+ * in order to enable future optimizations and extra features
+ */
+class Resolver {
+    constructor({ client, user, userRoleTagName = exports.DEFAULT_USER_ROLE_TAG_NAME, evalFuncName, }) {
+        this.client = client;
+        this.user = user;
+        this.userRoleTagName = userRoleTagName;
+        this.evalFuncName = evalFuncName;
+    }
+    client;
+    user;
+    userRoleTagName;
+    evalFuncName;
+    read(filter) {
+        return this.client.ext.read(filter);
+    }
+    makeWatch(dis, grid) {
+        return this.client.ops.watch.make(dis, grid);
+    }
+    /**
+     * Eval an expression using either the provided path or otherwse directly the expression
+     * Providing the path allows for whitelisting of certain functions to specific user roles
+     */
+    evalExprElement(expr, parameters, path) {
+        return this._eval(this._buildExpression(expr, parameters, path));
+    }
+    _buildExpression(expr, parameters, path) {
+        if (!!path && this.evalFuncName) {
+            return `${this.evalFuncName}(${haystack_core_1.HUri.make(path).toAxon()}, ${parameters.toAxon()})`;
+        }
+        else {
+            return (0, resolveTemplatedExpression_1.resolveTemplateExpression)(expr, parameters);
+        }
+    }
+    /**
+     * Evaluate an expression
+     */
+    async _eval(expr) {
+        const grid = await this.client.ext.eval(expr);
+        if (grid.isError()) {
+            console.error('Empty grid result for expression: \n', expr, grid.getError());
+        }
+        return grid;
+    }
+}
+exports.Resolver = Resolver;
 //# sourceMappingURL=Resolver.js.map

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

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

@@ -1,30 +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._meta) && !this.#initialized) {
-            this.#initialized = true;
-            return await this.doInitialize(parameters);
-        }
-    };
-    close = async () => {
-        if (this.#initialized) {
-            await this.doClose();
-            this.#initialized = false;
-        }
-    };
-}
-exports.ResolvableElement = ResolvableElement;
+"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._meta) && !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/ResolvableValueElement.d.ts

@@ -1,16 +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>);
-}
+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

@@ -1,39 +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;
+"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/UiElement.d.ts

@@ -1,31 +1,31 @@
-import { Resolver } from '../Resolver';
-export interface UiElementData<Meta extends UiElementMeta = UiElementMeta> {
-    _meta?: Meta;
-}
-export interface UiElementMeta {
-    access?: string[];
-}
-export interface UiElementConstructorData<T extends UiElementData> {
-    resolver: Resolver;
-    onUpdate: (value: unknown | undefined) => void;
-    element: T;
-    name?: string;
-}
-/**
- * Base UiElement class
- */
-export declare abstract class UiElement<T extends UiElementData = UiElementData> {
-    #private;
-    constructor({ name, element, resolver, onUpdate, }: UiElementConstructorData<T>);
-    resolver: Resolver;
-    _meta?: UiElementMeta;
-    name?: string;
-    toJSON(): Record<string, unknown>;
-    inspect(): void;
-    isAccessAllowed(meta?: UiElementMeta): boolean;
-    protected _value?: unknown;
-    get value(): unknown | undefined;
-    set value(value: unknown | undefined);
-    onUpdate: (value: unknown | undefined) => void;
-    static joinFilters(...filter: (string | undefined)[]): string;
-}
+import { Resolver } from '../Resolver';
+export interface UiElementData<Meta extends UiElementMeta = UiElementMeta> {
+    _meta?: Meta;
+}
+export interface UiElementMeta {
+    access?: string[];
+}
+export interface UiElementConstructorData<T extends UiElementData> {
+    resolver: Resolver;
+    onUpdate: (value: unknown | undefined) => void;
+    element: T;
+    name?: string;
+}
+/**
+ * Base UiElement class
+ */
+export declare abstract class UiElement<T extends UiElementData = UiElementData> {
+    #private;
+    constructor({ name, element, resolver, onUpdate, }: UiElementConstructorData<T>);
+    resolver: Resolver;
+    _meta?: UiElementMeta;
+    name?: string;
+    toJSON(): Record<string, unknown>;
+    inspect(): void;
+    isAccessAllowed(meta?: UiElementMeta): boolean;
+    protected _value?: unknown;
+    get value(): unknown | undefined;
+    set value(value: unknown | undefined);
+    onUpdate: (value: unknown | undefined) => void;
+    static joinFilters(...filter: (string | undefined)[]): string;
+}