@j2inn/resolvable-ui-elements 0.0.1-beta.0

package/dist_es/resolvableElements/react/useResolveSection.js

@@ -0,0 +1,55 @@
+import { useEffect, useReducer, useRef, useState } from 'react';
+import { makeParametersDict } from '../elements/function/FunctionElement';
+import { ResolvableSectionElement } from '../elements/section/ResolvableSectionElement';
+import { useResolverContext } from './useResolverContext';
+/**
+ * Resolves a section UI element.
+ * @param sectionData section data object
+ * @param parameters parameters for the resolution
+ * @returns the resolved result of the section that will be updated and force rendering when a subvalue changes.
+ */
+export function useResolveSection(sectionData, parameters) {
+    const [, update] = useReducer((count) => count + 1, 0);
+    const resolver = useResolverContext();
+    const [refreshes, refresh] = useReducer((count) => count + 1, 0);
+    const [initialResolvable] = useState(() => new ResolvableSectionElement({
+        element: sectionData,
+        resolver,
+        onUpdate: () => {
+            update();
+        },
+    }));
+    const ref = useRef(initialResolvable);
+    const parametersDict = makeParametersDict(parameters);
+    useEffect(() => {
+        if (areParametersValid(parameters)) {
+            ref.current = new ResolvableSectionElement({
+                element: sectionData,
+                resolver,
+                onUpdate: () => {
+                    update();
+                },
+            });
+            ref.current.initialize(parametersDict);
+            return () => {
+                ref.current?.close();
+            };
+        }
+        return;
+    }, [sectionData, resolver, refreshes, parametersDict.toAxon()]);
+    return [
+        (ref.current?.value ?? {}),
+        {
+            refresh: refresh,
+            element: ref.current,
+        },
+    ];
+}
+const areParametersValid = (parameters) => {
+    if (parameters &&
+        Object.entries(parameters).some(([, value]) => value == null)) {
+        return false;
+    }
+    return true;
+};
+//# sourceMappingURL=useResolveSection.js.map

package/dist_es/resolvableElements/react/useResolveSection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useResolveSection.js","sourceRoot":"","sources":["../../../src/resolvableElements/react/useResolveSection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAA;AAGvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAChC,WAAc,EACd,UAAmC;IAEnC,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IAC9D,MAAM,QAAQ,GAAG,kBAAkB,EAAE,CAAA;IACrC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,UAAU,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;IACxE,MAAM,CAAC,iBAAiB,CAAC,GAAG,QAAQ,CACnC,GAAG,EAAE,CACJ,IAAI,wBAAwB,CAAC;QAC5B,OAAO,EAAE,WAAW;QACpB,QAAQ;QACR,QAAQ,EAAE,GAAG,EAAE;YACd,MAAM,EAAE,CAAA;QACT,CAAC;KACD,CAAC,CACH,CAAA;IACD,MAAM,GAAG,GAAG,MAAM,CAA8B,iBAAiB,CAAC,CAAA;IAClE,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAA;IAErD,SAAS,CAAC,GAAG,EAAE;QACd,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACnC,GAAG,CAAC,OAAO,GAAG,IAAI,wBAAwB,CAAC;gBAC1C,OAAO,EAAE,WAAW;gBACpB,QAAQ;gBACR,QAAQ,EAAE,GAAG,EAAE;oBACd,MAAM,EAAE,CAAA;gBACT,CAAC;aACD,CAAC,CAAA;YAEF,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YAEtC,OAAO,GAAG,EAAE;gBACX,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,CAAA;YACrB,CAAC,CAAA;SACD;QACD,OAAM;IACP,CAAC,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAE/D,OAAO;QACN,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAA6B;QACtD;YACC,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,GAAG,CAAC,OAAO;SACpB;KACD,CAAA;AACF,CAAC;AAED,MAAM,kBAAkB,GAAG,CAC1B,UAAkC,EACjC,EAAE;IACH,IACC,UAAU;QACV,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,EAC5D;QACD,OAAO,KAAK,CAAA;KACZ;IACD,OAAO,IAAI,CAAA;AACZ,CAAC,CAAA"}

package/dist_es/resolvableElements/react/useResolverContext.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { Resolver } from '../Resolver';
+export declare function useResolverContext(): Resolver;
+export declare const ResolverProvider: React.FC;

package/dist_es/resolvableElements/react/useResolverContext.jsx

@@ -0,0 +1,26 @@
+import { Client } from 'haystack-nclient';
+import { useClient } from 'haystack-react';
+import React, { useContext, useEffect, useState } from 'react';
+import { useCurrentUser } from '../../useCurrentUser';
+import { Resolver } from '../Resolver';
+const ResolverContext = React.createContext(new Resolver({
+    client: new Client({
+        base: new URL(window.location.href),
+    }),
+}));
+ResolverContext.displayName = 'ResolverContext';
+export function useResolverContext() {
+    return useContext(ResolverContext);
+}
+export const ResolverProvider = ({ children }) => {
+    const client = useClient();
+    const user = useCurrentUser();
+    const [resolver, setResolver] = useState(() => new Resolver({ client, user }));
+    useEffect(() => {
+        setResolver(new Resolver({ client, user }));
+    }, [client, user]);
+    return (<ResolverContext.Provider value={resolver}>
+			{children}
+		</ResolverContext.Provider>);
+};
+//# sourceMappingURL=useResolverContext.jsx.map

package/dist_es/resolvableElements/react/useResolverContext.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"useResolverContext.jsx","sourceRoot":"","sources":["../../../src/resolvableElements/react/useResolverContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC,MAAM,eAAe,GAAG,KAAK,CAAC,aAAa,CAC1C,IAAI,QAAQ,CAAC;IACZ,MAAM,EAAE,IAAI,MAAM,CAAC;QAClB,IAAI,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;KACnC,CAAC;CACF,CAAC,CACF,CAAA;AAED,eAAe,CAAC,WAAW,GAAG,iBAAiB,CAAA;AAE/C,MAAM,UAAU,kBAAkB;IACjC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAA;AACnC,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAa,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;IAC1D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;IAC1B,MAAM,IAAI,GAAG,cAAc,EAAE,CAAA;IAE7B,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CACvC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CACpC,CAAA;IAED,SAAS,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,IAAI,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAC5C,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;IAElB,OAAO,CACN,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CACzC;GAAA,CAAC,QAAQ,CACV;EAAA,EAAE,eAAe,CAAC,QAAQ,CAAC,CAC3B,CAAA;AACF,CAAC,CAAA"}

package/dist_es/resolvableElements/resolveTemplatedExpression.d.ts

@@ -0,0 +1,19 @@
+import { HDict } from 'haystack-core';
+export declare const REG_EXPR_MATCHING_TEMPLATE: RegExp;
+/**
+ * Replaces variables (defined as <$parameterName>) in an expression with the values given in the parameters dict.
+ * The HVal.toAxon function is used for conversion to a string.
+ * @example
+ * resolveTemplatedExpression("func({{num}})", HDict.make({num: HNum.make("22")})) => "func(22)"
+ * @param expr the axon expression
+ * @param params the parameters expressed as dict
+ * @returns the axon expression resolved with the specified params
+ */
+export declare const resolveTemplateExpression: (expr: string, parameters?: HDict) => string;
+/**
+ * Replaces template variable found in the given string using a given replacer function
+ * @param templateString
+ * @param replacer
+ * @returns a new string containing the compiled template string
+ */
+export declare const replaceTemplateVariables: (templateString: string, replacer: (substring: string, match: string) => string) => string;

package/dist_es/resolvableElements/resolveTemplatedExpression.js

@@ -0,0 +1,28 @@
+export const REG_EXPR_MATCHING_TEMPLATE = new RegExp('{{([^{}]*)}}', 'g');
+/**
+ * Replaces variables (defined as <$parameterName>) in an expression with the values given in the parameters dict.
+ * The HVal.toAxon function is used for conversion to a string.
+ * @example
+ * resolveTemplatedExpression("func({{num}})", HDict.make({num: HNum.make("22")})) => "func(22)"
+ * @param expr the axon expression
+ * @param params the parameters expressed as dict
+ * @returns the axon expression resolved with the specified params
+ */
+export const resolveTemplateExpression = (expr, parameters) => {
+    const paramDict = parameters;
+    return replaceTemplateVariables(expr, (_substring, match) => {
+        const parameter = paramDict?.get(match)?.toAxon();
+        if (parameter != null) {
+            return parameter;
+        }
+        throw new Error(`ERROR: Missing parameter: ${match} in ${paramDict?.toAxon()}`);
+    });
+};
+/**
+ * Replaces template variable found in the given string using a given replacer function
+ * @param templateString
+ * @param replacer
+ * @returns a new string containing the compiled template string
+ */
+export const replaceTemplateVariables = (templateString, replacer) => templateString.replace(REG_EXPR_MATCHING_TEMPLATE, replacer);
+//# sourceMappingURL=resolveTemplatedExpression.js.map

package/dist_es/resolvableElements/resolveTemplatedExpression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveTemplatedExpression.js","sourceRoot":"","sources":["../../src/resolvableElements/resolveTemplatedExpression.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC,CAAA;AAEzE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACxC,IAAY,EACZ,UAAkB,EACT,EAAE;IACX,MAAM,SAAS,GAAG,UAAU,CAAA;IAE5B,OAAO,wBAAwB,CAC9B,IAAI,EACJ,CAAC,UAAkB,EAAE,KAAa,EAAE,EAAE;QACrC,MAAM,SAAS,GAAG,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,OAAO,SAAS,CAAA;SAChB;QACD,MAAM,IAAI,KAAK,CACd,6BAA6B,KAAK,OAAO,SAAS,EAAE,MAAM,EAAE,EAAE,CAC9D,CAAA;IACF,CAAC,CACD,CAAA;AACF,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACvC,cAAsB,EACtB,QAAsD,EAC7C,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAA"}

package/dist_es/useCurrentUser.d.ts

@@ -0,0 +1,4 @@
+import { HDict } from 'haystack-core';
+import React from 'react';
+export declare function useCurrentUser(): HDict | undefined;
+export declare const UserContextProvider: React.FC;

package/dist_es/useCurrentUser.jsx

@@ -0,0 +1,14 @@
+import { useEval } from 'haystack-react';
+import React, { useContext } from 'react';
+const UserContext = React.createContext(undefined);
+UserContext.displayName = 'CurrentUser';
+export function useCurrentUser() {
+    return useContext(UserContext);
+}
+export const UserContextProvider = ({ children }) => {
+    const { grid, isLoading } = useEval('finGetCurrentUser()');
+    return (<UserContext.Provider value={isLoading ? undefined : grid[0]}>
+			{children}
+		</UserContext.Provider>);
+};
+//# sourceMappingURL=useCurrentUser.jsx.map

package/dist_es/useCurrentUser.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCurrentUser.jsx","sourceRoot":"","sources":["../src/useCurrentUser.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AACxC,OAAO,KAAK,EAAE,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAEzC,MAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAoB,SAAS,CAAC,CAAA;AAErE,WAAW,CAAC,WAAW,GAAG,aAAa,CAAA;AAEvC,MAAM,UAAU,cAAc;IAC7B,OAAO,UAAU,CAAC,WAAW,CAAC,CAAA;AAC/B,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAa,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;IAC7D,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAE1D,OAAO,CACN,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAC5D;GAAA,CAAC,QAAQ,CACV;EAAA,EAAE,WAAW,CAAC,QAAQ,CAAC,CACvB,CAAA;AACF,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,52 @@
+{
+	"name": "@j2inn/resolvable-ui-elements",
+	"version": "0.0.1-beta.0",
+	"description": "",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"module": "dist_es/index.js",
+	"scripts": {
+		"clean": "rimraf ./dist && rimraf ./dist_es",
+		"prebuild": "npm run clean && npm run lint && npm run test",
+		"build": "tsc && npm run-script build:es",
+		"build:es": "tsc --module ESNext --outDir dist_es",
+		"checktypes": "tsc --noEmit",
+		"format": "prettier-eslint --list-different --write \"$(pwd)/src/**/*.{ts,tsx,js,jsx}\"",
+		"lint": "eslint --fix --ext ts,tsx,js,jsx src/",
+		"test": "jest --passWithNoTests",
+		"prepack": "npm run lint && npm run test && npm run build"
+	},
+	"author": "",
+	"license": "ISC",
+	"files": [
+		"dist/**/*",
+		"dist_es/**/*"
+	],
+	"peerDependencies": {
+		"haystack-core": "^2.0.37",
+		"haystack-nclient": "^3.0.26",
+		"haystack-units": "^1.0.19",
+		"haystack-react": "^3.0.9",
+		"react": "^17.0.2",
+		"react-dom": "^17.0.2"
+	},
+	"dependencies": {},
+	"devDependencies": {
+		"@types/jest": "^27.4.0",
+		"@types/node": "^15.0.2",
+		"@types/react": "^17.0.8",
+		"@typescript-eslint/eslint-plugin": "^5.28.0",
+		"@typescript-eslint/parser": "^5.28.0",
+		"eslint": "^7.32.0",
+		"eslint-config-prettier": "^8.3.0",
+		"eslint-plugin-jest": "^26.1.3",
+		"eslint-plugin-prettier": "^4.0.0",
+		"eslint-plugin-react": "^7.29.4",
+		"prettier": "^2.6.1",
+		"prettier-eslint": "^13.0.0",
+		"prettier-eslint-cli": "^5.0.1",
+		"rimraf": "^3.0.2",
+		"ts-jest": "^28.0.8",
+		"typescript": "^4.8.2"
+	}
+}