@genesislcap/foundation-criteria 14.303.0 → 14.303.2

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 (2) hide show
  1. package/package.json +11 -11
  2. package/docs/api-report.md +0 -234
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-criteria",
3
3
  "description": "Genesis Foundation UI Criteria Utils",
4
- "version": "14.303.0",
4
+ "version": "14.303.2",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -49,17 +49,17 @@
49
49
  }
50
50
  },
51
51
  "devDependencies": {
52
- "@genesislcap/foundation-testing": "14.303.0",
53
- "@genesislcap/genx": "14.303.0",
54
- "@genesislcap/rollup-builder": "14.303.0",
55
- "@genesislcap/ts-builder": "14.303.0",
56
- "@genesislcap/uvu-playwright-builder": "14.303.0",
57
- "@genesislcap/vite-builder": "14.303.0",
58
- "@genesislcap/webpack-builder": "14.303.0"
52
+ "@genesislcap/foundation-testing": "14.303.2",
53
+ "@genesislcap/genx": "14.303.2",
54
+ "@genesislcap/rollup-builder": "14.303.2",
55
+ "@genesislcap/ts-builder": "14.303.2",
56
+ "@genesislcap/uvu-playwright-builder": "14.303.2",
57
+ "@genesislcap/vite-builder": "14.303.2",
58
+ "@genesislcap/webpack-builder": "14.303.2"
59
59
  },
60
60
  "dependencies": {
61
- "@genesislcap/foundation-logger": "14.303.0",
62
- "@genesislcap/foundation-utils": "14.303.0",
61
+ "@genesislcap/foundation-logger": "14.303.2",
62
+ "@genesislcap/foundation-utils": "14.303.2",
63
63
  "@microsoft/fast-element": "1.14.0"
64
64
  },
65
65
  "repository": {
@@ -70,5 +70,5 @@
70
70
  "publishConfig": {
71
71
  "access": "public"
72
72
  },
73
- "gitHead": "1495670cf431019b7a29589f6ab7b80c0ec31945"
73
+ "gitHead": "f556f123bafe956a7ba9328bb3f78f4d7d2495ba"
74
74
  }
@@ -1,234 +0,0 @@
1
- ## API Report File for "@genesislcap/foundation-criteria"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { FASTElement } from '@microsoft/fast-element';
8
-
9
- // @public (undocumented)
10
- export const createFormCriteriaBuilder: <T>(criteriaBuilder: CriteriaBuilder) => (config: ExpressionConfig, formValue: any, formData: T) => void;
11
-
12
- // @public
13
- export class CriteriaBuilder {
14
- // (undocumented)
15
- And: (expression: ValidExpressionType, options?: ExpressionOptions) => this;
16
- // Warning: (ae-forgotten-export) The symbol "GroupedExpressions" needs to be exported by the entry point index.d.ts
17
- //
18
- // (undocumented)
19
- build(outputFn?: (groups: GroupedExpressions) => string): string;
20
- // (undocumented)
21
- Not: (expression: ValidExpressionType, options?: ExpressionOptions) => this;
22
- // (undocumented)
23
- Or: (expression: ValidExpressionType, options?: ExpressionOptions) => this;
24
- // (undocumented)
25
- reset(): void;
26
- // Warning: (ae-forgotten-export) The symbol "ValidExpressionType" needs to be exported by the entry point index.d.ts
27
- // Warning: (ae-forgotten-export) The symbol "ExpressionOptions" needs to be exported by the entry point index.d.ts
28
- //
29
- // (undocumented)
30
- withExpression(expression: ValidExpressionType, options?: ExpressionOptions, groupJoin?: Join): this;
31
- }
32
-
33
- // @public
34
- export class CriteriaSegmentedControl extends FASTElement {
35
- // Warning: (ae-incompatible-release-tags) The symbol "criteriaOptions" is marked as @public, but its signature references "CriteriaSegmentedControlOption" which is marked as @internal
36
- //
37
- // (undocumented)
38
- criteriaOptions: CriteriaSegmentedControlOption[];
39
- // (undocumented)
40
- itemClickHandler(label: string): void;
41
- // @internal
42
- prefix: any;
43
- // (undocumented)
44
- selectedLabel: string;
45
- // (undocumented)
46
- selectedLabelChanged(): void;
47
- // (undocumented)
48
- value: string;
49
- // (undocumented)
50
- valueChanged(): void;
51
- }
52
-
53
- // Warning: (ae-internal-missing-underscore) The name "CriteriaSegmentedControlOption" should be prefixed with an underscore because the declaration is marked as @internal
54
- //
55
- // @internal (undocumented)
56
- export type CriteriaSegmentedControlOption = {
57
- field: string;
58
- value: unknown;
59
- serialiser: Serialiser;
60
- label: string;
61
- };
62
-
63
- // Warning: (ae-internal-missing-underscore) The name "Expression" should be prefixed with an underscore because the declaration is marked as @internal
64
- //
65
- // @internal (undocumented)
66
- export type Expression = {
67
- field: string;
68
- value: unknown;
69
- serialiser: Serialiser;
70
- params: any;
71
- valueGetter?: (value: unknown) => string;
72
- group: string;
73
- };
74
-
75
- // @public (undocumented)
76
- export class ExpressionBuilder {
77
- constructor(opts?: Partial<{
78
- field: string;
79
- value: unknown;
80
- serialiser: Serialiser;
81
- params: any;
82
- valueGetter: (value: unknown) => string;
83
- group: string;
84
- }>);
85
- // Warning: (ae-incompatible-release-tags) The symbol "build" is marked as @public, but its signature references "Expression" which is marked as @internal
86
- //
87
- // (undocumented)
88
- build: () => Expression;
89
- // (undocumented)
90
- withField(field: string): ExpressionBuilder;
91
- // (undocumented)
92
- withGroup(group: string): ExpressionBuilder;
93
- // (undocumented)
94
- withParams(params: any): ExpressionBuilder;
95
- // Warning: (ae-incompatible-release-tags) The symbol "withSerialiser" is marked as @public, but its signature references "Serialiser" which is marked as @internal
96
- //
97
- // (undocumented)
98
- withSerialiser(serialiser: Serialiser): ExpressionBuilder;
99
- // (undocumented)
100
- withValue(value: unknown): ExpressionBuilder;
101
- // (undocumented)
102
- withValueGetter(valueGetter: (value: unknown) => string): ExpressionBuilder;
103
- }
104
-
105
- // @public
106
- export type ExpressionConfig<T = unknown, V = unknown, Y = unknown> = {
107
- criteria: (value: V, filters: T) => ExpressionParams<Y> | Array<ExpressionParams<Y>>;
108
- };
109
-
110
- // @public
111
- export type ExpressionConfigMap<T, Y = unknown> = Partial<{
112
- [key in keyof T]: ExpressionConfig<T, T[key], Y>;
113
- }>;
114
-
115
- // Warning: (ae-internal-missing-underscore) The name "ExpressionList" should be prefixed with an underscore because the declaration is marked as @internal
116
- //
117
- // @internal (undocumented)
118
- export type ExpressionList = Array<Expression | Join | ExpressionList>;
119
-
120
- // Warning: (ae-forgotten-export) The symbol "ExpressionValueType" needs to be exported by the entry point index.d.ts
121
- // Warning: (ae-internal-missing-underscore) The name "ExpressionParams" should be prefixed with an underscore because the declaration is marked as @internal
122
- //
123
- // @internal (undocumented)
124
- export type ExpressionParams<GroupName = ''> = [
125
- string | string[],
126
- Serialiser,
127
- ExpressionValueType | ExpressionValueType[],
128
- boolean?,
129
- GroupName?
130
- ];
131
-
132
- // @public
133
- export class Join {
134
- // Warning: (ae-incompatible-release-tags) The symbol "__constructor" is marked as @public, but its signature references "Operator" which is marked as @internal
135
- constructor(type: Operator);
136
- // (undocumented)
137
- static And(): Join;
138
- // (undocumented)
139
- static Equal(): Join;
140
- // (undocumented)
141
- static GreaterThan(): Join;
142
- // (undocumented)
143
- static GreaterThanOrEqual(): Join;
144
- // (undocumented)
145
- static LessThan(): Join;
146
- // (undocumented)
147
- static LessThanOrEqual(): Join;
148
- // (undocumented)
149
- static Not(): Join;
150
- // (undocumented)
151
- static NotEqual(): Join;
152
- // Warning: (ae-incompatible-release-tags) The symbol "operator" is marked as @public, but its signature references "Operator" which is marked as @internal
153
- //
154
- // (undocumented)
155
- get operator(): Operator;
156
- // (undocumented)
157
- static Or(): Join;
158
- }
159
-
160
- // Warning: (ae-internal-missing-underscore) The name "Operator" should be prefixed with an underscore because the declaration is marked as @internal
161
- //
162
- // @internal (undocumented)
163
- export enum Operator {
164
- // (undocumented)
165
- AND = "&&",
166
- // (undocumented)
167
- EQ = "==",
168
- // (undocumented)
169
- GE = ">=",
170
- // (undocumented)
171
- GT = ">",
172
- // (undocumented)
173
- LE = "<=",
174
- // (undocumented)
175
- LT = "<",
176
- // (undocumented)
177
- NE = "!=",
178
- // (undocumented)
179
- NOT = "!",
180
- // (undocumented)
181
- OR = "||"
182
- }
183
-
184
- // Warning: (ae-internal-missing-underscore) The name "Serialiser" should be prefixed with an underscore because the declaration is marked as @internal
185
- //
186
- // @internal (undocumented)
187
- export type Serialiser = (e: Expression) => string;
188
-
189
- // @public
190
- export const Serialisers: {
191
- AND: (e: Expression) => string;
192
- OR: (e: Expression) => string;
193
- NOT: (e: Expression) => string;
194
- GT: (e: Expression) => string;
195
- GE: (e: Expression) => string;
196
- LT: (e: Expression) => string;
197
- LE: (e: Expression) => string;
198
- NE: (e: Expression) => string;
199
- EQ: (e: Expression) => string;
200
- equals: (e: Expression) => string;
201
- equalsIgnoreCase: (e: Expression) => string;
202
- contains: (e: Expression) => string;
203
- fieldContains: (e: Expression) => string;
204
- containsIgnoreCase: (e: Expression) => string;
205
- dateIsEqual: (e: Expression) => string;
206
- dateIsGreaterEqual: (e: Expression) => string;
207
- dateIsLessEqual: (e: Expression) => string;
208
- };
209
-
210
- // Warnings were encountered during analysis:
211
- //
212
- // src/expression-builder.ts:19:7 - (ae-incompatible-release-tags) The symbol "serialiser" is marked as @public, but its signature references "Serialiser" which is marked as @internal
213
- // src/serialisers.ts:24:25 - (ae-incompatible-release-tags) The symbol "AND" is marked as @public, but its signature references "Expression" which is marked as @internal
214
- // src/serialisers.ts:26:3 - (ae-incompatible-release-tags) The symbol "OR" is marked as @public, but its signature references "Expression" which is marked as @internal
215
- // src/serialisers.ts:27:3 - (ae-incompatible-release-tags) The symbol "NOT" is marked as @public, but its signature references "Expression" which is marked as @internal
216
- // src/serialisers.ts:28:3 - (ae-incompatible-release-tags) The symbol "GT" is marked as @public, but its signature references "Expression" which is marked as @internal
217
- // src/serialisers.ts:29:3 - (ae-incompatible-release-tags) The symbol "GE" is marked as @public, but its signature references "Expression" which is marked as @internal
218
- // src/serialisers.ts:30:3 - (ae-incompatible-release-tags) The symbol "LT" is marked as @public, but its signature references "Expression" which is marked as @internal
219
- // src/serialisers.ts:31:3 - (ae-incompatible-release-tags) The symbol "LE" is marked as @public, but its signature references "Expression" which is marked as @internal
220
- // src/serialisers.ts:32:3 - (ae-incompatible-release-tags) The symbol "NE" is marked as @public, but its signature references "Expression" which is marked as @internal
221
- // src/serialisers.ts:33:3 - (ae-incompatible-release-tags) The symbol "EQ" is marked as @public, but its signature references "Expression" which is marked as @internal
222
- // src/serialisers.ts:34:3 - (ae-incompatible-release-tags) The symbol "equals" is marked as @public, but its signature references "Expression" which is marked as @internal
223
- // src/serialisers.ts:35:3 - (ae-incompatible-release-tags) The symbol "equalsIgnoreCase" is marked as @public, but its signature references "Expression" which is marked as @internal
224
- // src/serialisers.ts:36:3 - (ae-incompatible-release-tags) The symbol "contains" is marked as @public, but its signature references "Expression" which is marked as @internal
225
- // src/serialisers.ts:37:3 - (ae-incompatible-release-tags) The symbol "fieldContains" is marked as @public, but its signature references "Expression" which is marked as @internal
226
- // src/serialisers.ts:38:3 - (ae-incompatible-release-tags) The symbol "containsIgnoreCase" is marked as @public, but its signature references "Expression" which is marked as @internal
227
- // src/serialisers.ts:39:3 - (ae-incompatible-release-tags) The symbol "dateIsEqual" is marked as @public, but its signature references "Expression" which is marked as @internal
228
- // src/serialisers.ts:40:3 - (ae-incompatible-release-tags) The symbol "dateIsGreaterEqual" is marked as @public, but its signature references "Expression" which is marked as @internal
229
- // src/serialisers.ts:41:3 - (ae-incompatible-release-tags) The symbol "dateIsLessEqual" is marked as @public, but its signature references "Expression" which is marked as @internal
230
- // src/types.ts:47:3 - (ae-incompatible-release-tags) The symbol "criteria" is marked as @public, but its signature references "ExpressionParams" which is marked as @internal
231
-
232
- // (No @packageDocumentation comment for this package)
233
-
234
- ```