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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/dist/index.d.ts +12 -12
  2. package/dist/index.js +39 -39
  3. package/dist/resolvableElements/Resolver.d.ts +47 -47
  4. package/dist/resolvableElements/Resolver.js +57 -57
  5. package/dist/resolvableElements/elements/ResolvableElement.d.ts +14 -14
  6. package/dist/resolvableElements/elements/ResolvableElement.js +29 -29
  7. package/dist/resolvableElements/elements/ResolvableValueElement.d.ts +16 -16
  8. package/dist/resolvableElements/elements/ResolvableValueElement.js +38 -38
  9. package/dist/resolvableElements/elements/UiElement.d.ts +31 -31
  10. package/dist/resolvableElements/elements/UiElement.js +56 -56
  11. package/dist/resolvableElements/elements/expr/ResolvableExprElement.d.ts +26 -26
  12. package/dist/resolvableElements/elements/expr/ResolvableExprElement.js +105 -105
  13. package/dist/resolvableElements/elements/expr/ResolvableExprElementMeta.d.ts +10 -10
  14. package/dist/resolvableElements/elements/expr/ResolvableExprElementMeta.js +14 -14
  15. package/dist/resolvableElements/elements/function/FunctionElement.d.ts +12 -12
  16. package/dist/resolvableElements/elements/function/FunctionElement.js +41 -41
  17. package/dist/resolvableElements/elements/function/FunctionElementMeta.d.ts +9 -9
  18. package/dist/resolvableElements/elements/function/FunctionElementMeta.js +14 -14
  19. package/dist/resolvableElements/elements/list/ListElementMeta.d.ts +12 -12
  20. package/dist/resolvableElements/elements/list/ListElementMeta.js +14 -14
  21. package/dist/resolvableElements/elements/list/ResolvableListElement.d.ts +16 -16
  22. package/dist/resolvableElements/elements/list/ResolvableListElement.js +102 -102
  23. package/dist/resolvableElements/elements/makeElement.d.ts +7 -7
  24. package/dist/resolvableElements/elements/makeElement.js +40 -40
  25. package/dist/resolvableElements/elements/section/ResolvableSectionElement.d.ts +24 -24
  26. package/dist/resolvableElements/elements/section/ResolvableSectionElement.js +122 -122
  27. package/dist/resolvableElements/elements/section/SectionElementMeta.d.ts +16 -16
  28. package/dist/resolvableElements/elements/section/SectionElementMeta.js +11 -11
  29. package/dist/resolvableElements/elements/section/resolveSection.d.ts +12 -12
  30. package/dist/resolvableElements/elements/section/resolveSection.js +41 -41
  31. package/dist/resolvableElements/elements/tag/ResolvableTagElement.d.ts +16 -16
  32. package/dist/resolvableElements/elements/tag/ResolvableTagElement.js +105 -105
  33. package/dist/resolvableElements/elements/tag/TagElementMeta.d.ts +12 -12
  34. package/dist/resolvableElements/elements/tag/TagElementMeta.js +14 -14
  35. package/dist/resolvableElements/interfacesGeneration/generateInterfaces.d.ts +17 -17
  36. package/dist/resolvableElements/interfacesGeneration/generateInterfaces.js +135 -134
  37. package/dist/resolvableElements/interfacesGeneration/generateInterfaces.js.map +1 -1
  38. package/dist/resolvableElements/interfacesGeneration/generateTypescriptInterfacesFile.d.ts +4 -4
  39. package/dist/resolvableElements/interfacesGeneration/generateTypescriptInterfacesFile.js +41 -41
  40. package/dist/resolvableElements/react/SectionChecker.d.ts +24 -24
  41. package/dist/resolvableElements/react/SectionChecker.jsx +27 -27
  42. package/dist/resolvableElements/react/useResolveSection.d.ts +21 -21
  43. package/dist/resolvableElements/react/useResolveSection.js +65 -65
  44. package/dist/resolvableElements/react/useResolverContext.d.ts +9 -9
  45. package/dist/resolvableElements/react/useResolverContext.jsx +64 -64
  46. package/dist/resolvableElements/resolveTemplatedExpression.d.ts +22 -22
  47. package/dist/resolvableElements/resolveTemplatedExpression.js +43 -43
  48. package/dist/useCurrentUser.d.ts +10 -10
  49. package/dist/useCurrentUser.jsx +48 -48
  50. package/dist_es/index.d.ts +12 -12
  51. package/dist_es/index.js +20 -20
  52. package/dist_es/resolvableElements/Resolver.d.ts +47 -47
  53. package/dist_es/resolvableElements/Resolver.js +53 -53
  54. package/dist_es/resolvableElements/elements/ResolvableElement.d.ts +14 -14
  55. package/dist_es/resolvableElements/elements/ResolvableElement.js +25 -25
  56. package/dist_es/resolvableElements/elements/ResolvableValueElement.d.ts +16 -16
  57. package/dist_es/resolvableElements/elements/ResolvableValueElement.js +32 -32
  58. package/dist_es/resolvableElements/elements/UiElement.d.ts +31 -31
  59. package/dist_es/resolvableElements/elements/UiElement.js +52 -52
  60. package/dist_es/resolvableElements/elements/expr/ResolvableExprElement.d.ts +26 -26
  61. package/dist_es/resolvableElements/elements/expr/ResolvableExprElement.js +101 -101
  62. package/dist_es/resolvableElements/elements/expr/ResolvableExprElementMeta.d.ts +10 -10
  63. package/dist_es/resolvableElements/elements/expr/ResolvableExprElementMeta.js +9 -9
  64. package/dist_es/resolvableElements/elements/function/FunctionElement.d.ts +12 -12
  65. package/dist_es/resolvableElements/elements/function/FunctionElement.js +36 -36
  66. package/dist_es/resolvableElements/elements/function/FunctionElementMeta.d.ts +9 -9
  67. package/dist_es/resolvableElements/elements/function/FunctionElementMeta.js +9 -9
  68. package/dist_es/resolvableElements/elements/list/ListElementMeta.d.ts +12 -12
  69. package/dist_es/resolvableElements/elements/list/ListElementMeta.js +9 -9
  70. package/dist_es/resolvableElements/elements/list/ResolvableListElement.d.ts +16 -16
  71. package/dist_es/resolvableElements/elements/list/ResolvableListElement.js +98 -98
  72. package/dist_es/resolvableElements/elements/makeElement.d.ts +7 -7
  73. package/dist_es/resolvableElements/elements/makeElement.js +36 -36
  74. package/dist_es/resolvableElements/elements/section/ResolvableSectionElement.d.ts +24 -24
  75. package/dist_es/resolvableElements/elements/section/ResolvableSectionElement.js +117 -117
  76. package/dist_es/resolvableElements/elements/section/SectionElementMeta.d.ts +16 -16
  77. package/dist_es/resolvableElements/elements/section/SectionElementMeta.js +6 -6
  78. package/dist_es/resolvableElements/elements/section/resolveSection.d.ts +12 -12
  79. package/dist_es/resolvableElements/elements/section/resolveSection.js +36 -36
  80. package/dist_es/resolvableElements/elements/tag/ResolvableTagElement.d.ts +16 -16
  81. package/dist_es/resolvableElements/elements/tag/ResolvableTagElement.js +101 -101
  82. package/dist_es/resolvableElements/elements/tag/TagElementMeta.d.ts +12 -12
  83. package/dist_es/resolvableElements/elements/tag/TagElementMeta.js +9 -9
  84. package/dist_es/resolvableElements/interfacesGeneration/generateInterfaces.d.ts +17 -17
  85. package/dist_es/resolvableElements/interfacesGeneration/generateInterfaces.js +129 -128
  86. package/dist_es/resolvableElements/interfacesGeneration/generateInterfaces.js.map +1 -1
  87. package/dist_es/resolvableElements/interfacesGeneration/generateTypescriptInterfacesFile.d.ts +4 -4
  88. package/dist_es/resolvableElements/interfacesGeneration/generateTypescriptInterfacesFile.js +15 -15
  89. package/dist_es/resolvableElements/react/SectionChecker.d.ts +24 -24
  90. package/dist_es/resolvableElements/react/SectionChecker.jsx +20 -20
  91. package/dist_es/resolvableElements/react/useResolveSection.d.ts +21 -21
  92. package/dist_es/resolvableElements/react/useResolveSection.js +61 -61
  93. package/dist_es/resolvableElements/react/useResolverContext.d.ts +9 -9
  94. package/dist_es/resolvableElements/react/useResolverContext.jsx +36 -36
  95. package/dist_es/resolvableElements/resolveTemplatedExpression.d.ts +22 -22
  96. package/dist_es/resolvableElements/resolveTemplatedExpression.js +38 -38
  97. package/dist_es/useCurrentUser.d.ts +10 -10
  98. package/dist_es/useCurrentUser.jsx +20 -20
  99. package/package.json +5 -5
@@ -1,37 +1,37 @@
1
- /*
2
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
3
- */
4
- import { makeParametersDict } from '../function/FunctionElement';
5
- import { ResolvableSectionElement } from './ResolvableSectionElement';
6
- /**
7
- * Resolves a section UI element.
8
- * @param resolver the Resolver context
9
- * @param sectionData section data object
10
- * @param parameters parameters for the resolution
11
- * @returns the resolved result of the section.
12
- */
13
- export async function resolveSection(resolver, sectionData, parameters) {
14
- const parametersDict = makeParametersDict(parameters);
15
- if (areParametersValid(parameters)) {
16
- const sectionElement = new ResolvableSectionElement({
17
- element: sectionData,
18
- resolver,
19
- onUpdate: () => {
20
- return;
21
- },
22
- });
23
- await sectionElement
24
- .initialize(parametersDict)
25
- .finally(() => sectionElement?.close());
26
- return sectionElement.value;
27
- }
28
- return undefined;
29
- }
30
- export const areParametersValid = (parameters) => {
31
- if (parameters &&
32
- Object.entries(parameters).some(([, value]) => value == null)) {
33
- return false;
34
- }
35
- return true;
36
- };
1
+ /*
2
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
3
+ */
4
+ import { makeParametersDict } from '../function/FunctionElement';
5
+ import { ResolvableSectionElement } from './ResolvableSectionElement';
6
+ /**
7
+ * Resolves a section UI element.
8
+ * @param resolver the Resolver context
9
+ * @param sectionData section data object
10
+ * @param parameters parameters for the resolution
11
+ * @returns the resolved result of the section.
12
+ */
13
+ export async function resolveSection(resolver, sectionData, parameters) {
14
+ const parametersDict = makeParametersDict(parameters);
15
+ if (areParametersValid(parameters)) {
16
+ const sectionElement = new ResolvableSectionElement({
17
+ element: sectionData,
18
+ resolver,
19
+ onUpdate: () => {
20
+ return;
21
+ },
22
+ });
23
+ await sectionElement
24
+ .initialize(parametersDict)
25
+ .finally(() => sectionElement?.close());
26
+ return sectionElement.value;
27
+ }
28
+ return undefined;
29
+ }
30
+ export const areParametersValid = (parameters) => {
31
+ if (parameters &&
32
+ Object.entries(parameters).some(([, value]) => value == null)) {
33
+ return false;
34
+ }
35
+ return true;
36
+ };
37
37
  //# sourceMappingURL=resolveSection.js.map
@@ -1,16 +1,16 @@
1
- import { HDict } from 'haystack-core';
2
- import { Watch } from 'haystack-nclient';
3
- import { ResolvableValueElement } from '../ResolvableValueElement';
4
- import { UiElementConstructorData, UiElementData } from '../UiElement';
5
- /**
6
- * Resolves to the value of a tag on a record and keeps it updated using a watch.
7
- */
8
- export declare class ResolvableTagElement<T extends UiElementData> extends ResolvableValueElement<T> {
9
- #private;
10
- constructor(data: UiElementConstructorData<T>);
11
- filter?: string;
12
- watch?: Watch;
13
- protected doInitialize: (parameters: HDict) => Promise<void>;
14
- protected doClose: () => Promise<void>;
15
- getParameterList: () => string[];
16
- }
1
+ import { HDict } from 'haystack-core';
2
+ import { Watch } from 'haystack-nclient';
3
+ import { ResolvableValueElement } from '../ResolvableValueElement';
4
+ import { UiElementConstructorData, UiElementData } from '../UiElement';
5
+ /**
6
+ * Resolves to the value of a tag on a record and keeps it updated using a watch.
7
+ */
8
+ export declare class ResolvableTagElement<T extends UiElementData> extends ResolvableValueElement<T> {
9
+ #private;
10
+ constructor(data: UiElementConstructorData<T>);
11
+ filter?: string;
12
+ watch?: Watch;
13
+ protected doInitialize: (parameters: HDict) => Promise<void>;
14
+ protected doClose: () => Promise<void>;
15
+ getParameterList: () => string[];
16
+ }
@@ -1,102 +1,102 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- import { HFilter } from 'haystack-core';
5
- import { DEFAULT_POLL_RATE_SECS } from 'haystack-nclient';
6
- import { replaceTemplateVariables, resolveTemplateExpression, } from '../../resolveTemplatedExpression';
7
- import { ResolvableValueElement } from '../ResolvableValueElement';
8
- import { UiElement, } from '../UiElement';
9
- /**
10
- * Resolves to the value of a tag on a record and keeps it updated using a watch.
11
- */
12
- export class ResolvableTagElement extends ResolvableValueElement {
13
- constructor(data) {
14
- super(data);
15
- }
16
- filter;
17
- watch;
18
- doInitialize = async (parameters) => {
19
- const { subscribe, entityBinding, parentBinding } = this
20
- ._meta;
21
- const filter = resolveTemplateExpression(UiElement.joinFilters(entityBinding, parentBinding), parameters);
22
- if (!this.#isValidFilter(filter)) {
23
- throw Error('Invalid filter');
24
- }
25
- this.filter = filter;
26
- const grid = await this.resolver.read(this.filter);
27
- if (!this.#isValidReadGrid(grid)) {
28
- return;
29
- }
30
- this.#updateValue(grid);
31
- if (subscribe) {
32
- await this.#setupWatch(grid);
33
- }
34
- };
35
- doClose = async () => {
36
- return this.watch?.close();
37
- };
38
- getParameterList = () => {
39
- const { entityBinding, parentBinding } = this
40
- ._meta;
41
- const parameters = [];
42
- if (entityBinding) {
43
- replaceTemplateVariables(entityBinding, (_, match) => {
44
- parameters.push(match);
45
- return '';
46
- });
47
- }
48
- if (parentBinding) {
49
- replaceTemplateVariables(parentBinding, (_, match) => {
50
- parameters.push(match);
51
- return '';
52
- });
53
- }
54
- return parameters;
55
- };
56
- #isValidFilter = (filter) => {
57
- try {
58
- HFilter.parse(filter);
59
- }
60
- catch (e) {
61
- console.error('Invalid filter: \n', this.filter, e);
62
- return false;
63
- }
64
- return true;
65
- };
66
- #isValidReadGrid = (grid) => {
67
- if (grid.isEmpty()) {
68
- console.error('Empty grid result for query: \n', this.filter);
69
- return false;
70
- }
71
- if (grid.length > 1) {
72
- console.warn('More than 1 result for query: \n', this.filter);
73
- }
74
- return true;
75
- };
76
- #setupWatch = async (grid) => {
77
- const { readTag, subscribePollRate, subscribe } = this
78
- ._meta;
79
- if (subscribe) {
80
- this.watch = await this.resolver.makeWatch(this.#getWatchDisplayName(), grid);
81
- const updateValue = () => this.#updateValue(this.watch?.grid);
82
- // Update with the value received when opening the watch
83
- updateValue();
84
- // Configure polling options
85
- this.watch.pollRate = subscribePollRate ?? DEFAULT_POLL_RATE_SECS;
86
- this.watch.changed({
87
- interests: [readTag],
88
- callback: updateValue,
89
- });
90
- }
91
- };
92
- #updateValue = (grid) => {
93
- const { readTag } = this._meta;
94
- if (grid) {
95
- this.value = grid[0]?.get(readTag);
96
- }
97
- };
98
- #getWatchDisplayName = () => {
99
- return `ResolvableElement Watch for ${this.name ?? this.filter}`;
100
- };
101
- }
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ import { HFilter } from 'haystack-core';
5
+ import { DEFAULT_POLL_RATE_SECS } from 'haystack-nclient';
6
+ import { replaceTemplateVariables, resolveTemplateExpression, } from '../../resolveTemplatedExpression';
7
+ import { ResolvableValueElement } from '../ResolvableValueElement';
8
+ import { UiElement, } from '../UiElement';
9
+ /**
10
+ * Resolves to the value of a tag on a record and keeps it updated using a watch.
11
+ */
12
+ export class ResolvableTagElement extends ResolvableValueElement {
13
+ constructor(data) {
14
+ super(data);
15
+ }
16
+ filter;
17
+ watch;
18
+ doInitialize = async (parameters) => {
19
+ const { subscribe, entityBinding, parentBinding } = this
20
+ ._meta;
21
+ const filter = resolveTemplateExpression(UiElement.joinFilters(entityBinding, parentBinding), parameters);
22
+ if (!this.#isValidFilter(filter)) {
23
+ throw Error('Invalid filter');
24
+ }
25
+ this.filter = filter;
26
+ const grid = await this.resolver.read(this.filter);
27
+ if (!this.#isValidReadGrid(grid)) {
28
+ return;
29
+ }
30
+ this.#updateValue(grid);
31
+ if (subscribe) {
32
+ await this.#setupWatch(grid);
33
+ }
34
+ };
35
+ doClose = async () => {
36
+ return this.watch?.close();
37
+ };
38
+ getParameterList = () => {
39
+ const { entityBinding, parentBinding } = this
40
+ ._meta;
41
+ const parameters = [];
42
+ if (entityBinding) {
43
+ replaceTemplateVariables(entityBinding, (_, match) => {
44
+ parameters.push(match);
45
+ return '';
46
+ });
47
+ }
48
+ if (parentBinding) {
49
+ replaceTemplateVariables(parentBinding, (_, match) => {
50
+ parameters.push(match);
51
+ return '';
52
+ });
53
+ }
54
+ return parameters;
55
+ };
56
+ #isValidFilter = (filter) => {
57
+ try {
58
+ HFilter.parse(filter);
59
+ }
60
+ catch (e) {
61
+ console.error('Invalid filter: \n', this.filter, e);
62
+ return false;
63
+ }
64
+ return true;
65
+ };
66
+ #isValidReadGrid = (grid) => {
67
+ if (grid.isEmpty()) {
68
+ console.error('Empty grid result for query: \n', this.filter);
69
+ return false;
70
+ }
71
+ if (grid.length > 1) {
72
+ console.warn('More than 1 result for query: \n', this.filter);
73
+ }
74
+ return true;
75
+ };
76
+ #setupWatch = async (grid) => {
77
+ const { readTag, subscribePollRate, subscribe } = this
78
+ ._meta;
79
+ if (subscribe) {
80
+ this.watch = await this.resolver.makeWatch(this.#getWatchDisplayName(), grid);
81
+ const updateValue = () => this.#updateValue(this.watch?.grid);
82
+ // Update with the value received when opening the watch
83
+ updateValue();
84
+ // Configure polling options
85
+ this.watch.pollRate = subscribePollRate ?? DEFAULT_POLL_RATE_SECS;
86
+ this.watch.changed({
87
+ interests: [readTag],
88
+ callback: updateValue,
89
+ });
90
+ }
91
+ };
92
+ #updateValue = (grid) => {
93
+ const { readTag } = this._meta;
94
+ if (grid) {
95
+ this.value = grid[0]?.get(readTag);
96
+ }
97
+ };
98
+ #getWatchDisplayName = () => {
99
+ return `ResolvableElement Watch for ${this.name ?? this.filter}`;
100
+ };
101
+ }
102
102
  //# sourceMappingURL=ResolvableTagElement.js.map
@@ -1,12 +1,12 @@
1
- import { ResolvableValueElementMeta } from '../ResolvableValueElement';
2
- import { UiElementData, UiElementMeta } from '../UiElement';
3
- export interface UiElementTagMetaBase extends ResolvableValueElementMeta {
4
- resolutionType: 'tag';
5
- readTag: string;
6
- parentBinding?: string;
7
- entityBinding?: string;
8
- subscribe?: boolean;
9
- subscribePollRate?: number;
10
- }
11
- export declare const isResolvableTagElementData: (element: UiElementData) => element is UiElementData<UiElementTagMetaBase>;
12
- export declare const isResolvableTagMeta: (meta: UiElementMeta) => meta is UiElementTagMetaBase;
1
+ import { ResolvableValueElementMeta } from '../ResolvableValueElement';
2
+ import { UiElementData, UiElementMeta } from '../UiElement';
3
+ export interface UiElementTagMetaBase extends ResolvableValueElementMeta {
4
+ resolutionType: 'tag';
5
+ readTag: string;
6
+ parentBinding?: string;
7
+ entityBinding?: string;
8
+ subscribe?: boolean;
9
+ subscribePollRate?: number;
10
+ }
11
+ export declare const isResolvableTagElementData: (element: UiElementData) => element is UiElementData<UiElementTagMetaBase>;
12
+ export declare const isResolvableTagMeta: (meta: UiElementMeta) => meta is UiElementTagMetaBase;
@@ -1,10 +1,10 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- export const isResolvableTagElementData = (element) => {
5
- return !!element?._meta && isResolvableTagMeta(element._meta);
6
- };
7
- export const isResolvableTagMeta = (meta) => {
8
- return meta.resolutionType === 'tag';
9
- };
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ export const isResolvableTagElementData = (element) => {
5
+ return !!element?._meta && isResolvableTagMeta(element._meta);
6
+ };
7
+ export const isResolvableTagMeta = (meta) => {
8
+ return meta.resolutionType === 'tag';
9
+ };
10
10
  //# sourceMappingURL=TagElementMeta.js.map
@@ -1,17 +1,17 @@
1
- import { ResolvableSectionElement } from '../elements/section/ResolvableSectionElement';
2
- import { UiElementSectionMeta } from '../elements/section/SectionElementMeta';
3
- import { UiElementData } from '../elements/UiElement';
4
- export declare const generateInterfaces: (section: UiElementData<UiElementSectionMeta>) => string;
5
- /**
6
- * Class for generating typescript interfaces from a section data.
7
- */
8
- export declare class SectionInterfacesGenerator {
9
- #private;
10
- constructor(section: UiElementData<UiElementSectionMeta>);
11
- sectionData: UiElementData<UiElementSectionMeta>;
12
- output: string;
13
- generate: () => string;
14
- generateInterface(section: ResolvableSectionElement, indentation: number): void;
15
- generateNamespace(section: ResolvableSectionElement<UiElementData<UiElementSectionMeta>>, indentation: number): void;
16
- }
17
- export declare function makeResolvableSectionElementMock(sectionData: UiElementData<UiElementSectionMeta>, name?: string): ResolvableSectionElement<UiElementData<UiElementSectionMeta>>;
1
+ import { ResolvableSectionElement } from '../elements/section/ResolvableSectionElement';
2
+ import { UiElementSectionMeta } from '../elements/section/SectionElementMeta';
3
+ import { UiElementData } from '../elements/UiElement';
4
+ export declare const generateInterfaces: (section: UiElementData<UiElementSectionMeta>) => string;
5
+ /**
6
+ * Class for generating typescript interfaces from a section data.
7
+ */
8
+ export declare class SectionInterfacesGenerator {
9
+ #private;
10
+ constructor(section: UiElementData<UiElementSectionMeta>);
11
+ sectionData: UiElementData<UiElementSectionMeta>;
12
+ output: string;
13
+ generate: () => string;
14
+ generateInterface(section: ResolvableSectionElement, indentation: number): void;
15
+ generateNamespace(section: ResolvableSectionElement<UiElementData<UiElementSectionMeta>>, indentation: number): void;
16
+ }
17
+ export declare function makeResolvableSectionElementMock(sectionData: UiElementData<UiElementSectionMeta>, name?: string): ResolvableSectionElement<UiElementData<UiElementSectionMeta>>;