@sassoftware/vi-api 1.44.0 → 1.48.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.
- package/alert-reps/index.d.ts +5 -5
- package/alert-reps/package.json +1 -1
- package/component/bindings.d.ts +169 -2
- package/component/bindings.js +7 -1
- package/component/index.d.ts +2 -2
- package/config/config-api.d.ts +3 -14
- package/config/control-attribute-types.d.ts +168 -0
- package/config/control-attribute-types.js +1 -0
- package/config/index.d.ts +3 -0
- package/config/index.js +3 -0
- package/config/standardPropertyTypes.d.ts +50 -0
- package/config/standardPropertyTypes.js +52 -0
- package/config/status.d.ts +7 -0
- package/config/status.js +8 -0
- package/control/control-api.d.ts +56 -1
- package/control/page.d.ts +1 -1
- package/control/page.js +8 -1
- package/current-user/currentUser-api.d.ts +9 -1
- package/current-user/currentUser-api.js +2 -0
- package/package.json +1 -1
- package/property/property-api.d.ts +2 -15
- package/score-reps/index.d.ts +1 -1
- package/score-reps/package.json +1 -1
- package/shell-tabs/shell-tabs-api.d.ts +7 -0
- package/svi-datahub/index.d.ts +90 -42
- package/svi-datahub/package.json +1 -1
- package/svi-sand/index.d.ts +16 -7
- package/svi-sand/package.json +1 -1
package/alert-reps/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
|
-
// Generated using typescript-generator version 2.15.527 on
|
|
3
|
+
// Generated using typescript-generator version 2.15.527 on 2025-04-07 09:10:30.
|
|
4
4
|
|
|
5
5
|
export interface ActionRequestRep {
|
|
6
6
|
version?: number;
|
|
@@ -115,8 +115,6 @@ export interface AlertRep extends BaseRep {
|
|
|
115
115
|
autoActivateScore?: number;
|
|
116
116
|
strategyRangeLow?: number;
|
|
117
117
|
strategyRangeHigh?: number;
|
|
118
|
-
alertVersionTimestamp?: string;
|
|
119
|
-
statusTimestamp?: string;
|
|
120
118
|
dispositionTimestamp?: string;
|
|
121
119
|
suppressionEndTimestamp?: string;
|
|
122
120
|
holdEndTimestamp?: string;
|
|
@@ -127,6 +125,8 @@ export interface AlertRep extends BaseRep {
|
|
|
127
125
|
systemServiceTimestamp?: string;
|
|
128
126
|
autoCloseTimestamp?: string;
|
|
129
127
|
autoActivateTimestamp?: string;
|
|
128
|
+
alertVersionTimestamp?: string;
|
|
129
|
+
statusTimestamp?: string;
|
|
130
130
|
}
|
|
131
131
|
|
|
132
132
|
export interface AlertVersionSummaryRep {
|
|
@@ -139,8 +139,8 @@ export interface AlertVersionSummaryRep {
|
|
|
139
139
|
versionDispositionResolutionCode?: string;
|
|
140
140
|
versionScore?: number;
|
|
141
141
|
versionLastUpdateTimeStamp?: string;
|
|
142
|
-
versionLastUpdateTimestamp?: string;
|
|
143
142
|
versionCreationTimestamp?: string;
|
|
143
|
+
versionLastUpdateTimestamp?: string;
|
|
144
144
|
}
|
|
145
145
|
|
|
146
146
|
export interface AlertWorkflowRep {
|
|
@@ -640,8 +640,8 @@ export interface Link extends Serializable, Comparable<Link> {
|
|
|
640
640
|
}
|
|
641
641
|
|
|
642
642
|
export interface TypedPayload {
|
|
643
|
-
eventType?: string;
|
|
644
643
|
payloadType?: string;
|
|
644
|
+
eventType?: string;
|
|
645
645
|
}
|
|
646
646
|
|
|
647
647
|
export interface TrackedResource extends Serializable, ETaggable, TimeTrackedResource, ETagAndLastModifiedProvider {
|
package/alert-reps/package.json
CHANGED
package/component/bindings.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { PageDataChange, PageModeChange } from "../control/events";
|
|
2
2
|
import { Relationship } from "../svi-datahub";
|
|
3
3
|
import { QueryMode } from "../svi-sand";
|
|
4
|
-
import { ControlContainer } from "../object/object-api";
|
|
4
|
+
import { ControlContainer, VIObject } from "../object/object-api";
|
|
5
5
|
import { PageModel, PageModelObjectData } from "../page-model/page-model-api";
|
|
6
6
|
import { SearchObject, SearchQuery } from "../search/client/client-search-api";
|
|
7
7
|
import { HandleType, MinMaxDates, TimeSliderContextMenuHideOptions, TimeSliderEventDates, TimeSliderRange, TimeSliderRangeChangedEvent } from "../time-slider";
|
|
8
|
+
import { PageModeEvent } from "../control";
|
|
8
9
|
export interface SearchAndSelectWithPreviewInputBindings {
|
|
9
10
|
initialQuery?: string;
|
|
10
11
|
additionalModes?: QueryMode[];
|
|
@@ -19,7 +20,113 @@ export interface PageViewerApi {
|
|
|
19
20
|
isDirty: () => boolean;
|
|
20
21
|
isValid: () => Promise<boolean>;
|
|
21
22
|
}
|
|
23
|
+
export type PageViewerBindings = CreateObjectPageBindings | EditObjectPageBindings | ViewObjectPageBindings | StaticDataPageBindings | PageBindings;
|
|
24
|
+
export declare enum PageViewerBindingsType {
|
|
25
|
+
CreateObject = "CREATE",
|
|
26
|
+
EditObject = "EDIT",
|
|
27
|
+
ViewObject = "VIEW",
|
|
28
|
+
StaticData = "STATIC"
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Component bindings to configure a page viewer for creating a new object.
|
|
32
|
+
*/
|
|
33
|
+
export interface CreateObjectPageBindings extends CommonPageViewerBindings {
|
|
34
|
+
bindingsType: PageViewerBindingsType.CreateObject;
|
|
35
|
+
/** Page context to use. */
|
|
36
|
+
eventName: PageModeEvent.CREATE;
|
|
37
|
+
/** Entity type of the object. */
|
|
38
|
+
docType: string;
|
|
39
|
+
/** Temporary ID to use for the unsaved object. */
|
|
40
|
+
tempCreateId?: string;
|
|
41
|
+
/** Initial values to populate the pageModel data. */
|
|
42
|
+
initialCreateData?: Record<string, any>;
|
|
43
|
+
/**
|
|
44
|
+
* Optionally provide a pageModel using window.sas.vi.pageModel.createFromObject.
|
|
45
|
+
* The pageModel type must match docType.
|
|
46
|
+
* The pageModel data will be populated with initialCreateData.
|
|
47
|
+
* The pageModel can be used to inspect current data and validity
|
|
48
|
+
* but the reference to this model will be broken if a new template is to be loaded due to a mode transition or other condition.
|
|
49
|
+
* Prefer using setApi and onChange to interact with the page.
|
|
50
|
+
*/
|
|
51
|
+
pageModel?: PageModel;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Component bindings to configure a page viewer for editing an existing object.
|
|
55
|
+
*/
|
|
56
|
+
export interface EditObjectPageBindings extends CommonPageViewerBindings {
|
|
57
|
+
bindingsType: PageViewerBindingsType.EditObject;
|
|
58
|
+
/** Page context to use. */
|
|
59
|
+
eventName: PageModeEvent.EDIT;
|
|
60
|
+
/** Entity type of the object. */
|
|
61
|
+
docType: string;
|
|
62
|
+
/** Object ID */
|
|
63
|
+
docId: string;
|
|
64
|
+
/** Use the given page template by UUID regardless of page context. */
|
|
65
|
+
templateUuid?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Optionally provide a pageModel using window.sas.vi.pageModel.createFromObject.
|
|
68
|
+
* The pageModel type must match docType.
|
|
69
|
+
* The pageModel data will be populated using the loaded object response from the given docType and docId.
|
|
70
|
+
* The pageModel can be used to inspect current data and validity
|
|
71
|
+
* but the reference to this model will be broken if a new template is to be loaded due to a mode transition or other condition.
|
|
72
|
+
* Prefer using setApi and onChange to interact with the page.
|
|
73
|
+
*/
|
|
74
|
+
pageModel?: PageModel;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Component bindings to configure a page viewer for a read-only view of an existing object.
|
|
78
|
+
*/
|
|
79
|
+
export interface ViewObjectPageBindings extends CommonPageViewerBindings {
|
|
80
|
+
bindingsType: PageViewerBindingsType.ViewObject;
|
|
81
|
+
/** Page context to use. */
|
|
82
|
+
eventName: PageModeEvent.OPEN | PageModeEvent.INSPECT | PageModeEvent.SUMMARY;
|
|
83
|
+
/** Entity type of the object. */
|
|
84
|
+
docType: string;
|
|
85
|
+
/** Object ID */
|
|
86
|
+
docId: string;
|
|
87
|
+
/** Use the given page template by UUID regardless of page context. */
|
|
88
|
+
templateUuid?: string;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Component bindings to configure a page viewer for a read-only view of static object data.
|
|
92
|
+
*/
|
|
93
|
+
export interface StaticDataPageBindings extends CommonPageViewerBindings {
|
|
94
|
+
bindingsType: PageViewerBindingsType.StaticData;
|
|
95
|
+
/** Object data to create the page response. */
|
|
96
|
+
staticDocumentData: VIObject;
|
|
97
|
+
}
|
|
98
|
+
export interface CommonPageViewerBindings {
|
|
99
|
+
/** Show the page toolbar. This contains the toolbar actions associated with the object's Entity type. */
|
|
100
|
+
showToolbar?: boolean;
|
|
101
|
+
/**
|
|
102
|
+
* Assign the given CSS classes to the page viewer's container.
|
|
103
|
+
* This is the element which encompasses the main document view and the toolbar.
|
|
104
|
+
*/
|
|
105
|
+
containerClass?: string;
|
|
106
|
+
/** If true, the page viewer will fill its parent element's height. */
|
|
107
|
+
fitToContainerHeight?: boolean;
|
|
108
|
+
/**
|
|
109
|
+
* Assign the given CSS classes to the page viewer's main section.
|
|
110
|
+
* This is the element which displays the main document, excluding toolbar.
|
|
111
|
+
*/
|
|
112
|
+
pageClass?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Enable workspace and insight tabs to be rendered.
|
|
115
|
+
*/
|
|
116
|
+
enableSheets?: boolean;
|
|
117
|
+
/**
|
|
118
|
+
* A callback which is called when the page viewer is initialized.
|
|
119
|
+
* It provides an API which can be used to check the page viewer state and save the document.
|
|
120
|
+
*/
|
|
121
|
+
setApi?: (api: PageViewerApi) => void;
|
|
122
|
+
/** A callback which is called when the page viewer dirty state changes. */
|
|
123
|
+
onDirty?: (isDirty: boolean) => void;
|
|
124
|
+
/** A callback which is called when the pageModel's mode or data changes. */
|
|
125
|
+
onChange?: (change: PageDataChange | PageModeChange) => void;
|
|
126
|
+
}
|
|
127
|
+
/** @deprecated use {@link PageViewerBindings} */
|
|
22
128
|
export interface PageBindings {
|
|
129
|
+
bindingsType?: never;
|
|
23
130
|
docId?: string;
|
|
24
131
|
docType?: string;
|
|
25
132
|
eventName?: string;
|
|
@@ -46,24 +153,84 @@ export interface ControlCollectionBindings {
|
|
|
46
153
|
pageModel?: PageModel;
|
|
47
154
|
root?: boolean;
|
|
48
155
|
}
|
|
156
|
+
/**
|
|
157
|
+
* Defines the bindings for managing relationship details in a component.
|
|
158
|
+
*/
|
|
49
159
|
export interface RelationshipDetailsBindings {
|
|
160
|
+
/**
|
|
161
|
+
* Defines the identifier of the target object type that the relationship references.
|
|
162
|
+
*/
|
|
50
163
|
targetObjectTypeName: string;
|
|
164
|
+
/**
|
|
165
|
+
* Defines the display label of the target object type.
|
|
166
|
+
*/
|
|
51
167
|
targetObjectTypeLabel: string;
|
|
168
|
+
/**
|
|
169
|
+
* Defines the identifier of the parent object type that owns the relationship.
|
|
170
|
+
*/
|
|
52
171
|
parentObjectTypeName: string;
|
|
172
|
+
/**
|
|
173
|
+
* Specifies the user-friendly label of the parent object type.
|
|
174
|
+
*/
|
|
53
175
|
parentObjectTypeLabel: string;
|
|
176
|
+
/**
|
|
177
|
+
* Represents the list of reasons that define the purpose or context of the relationship.
|
|
178
|
+
*/
|
|
54
179
|
linkReasons: Relationship[];
|
|
180
|
+
/**
|
|
181
|
+
* Represents the currently selected item in the relationship, if applicable.
|
|
182
|
+
* Contains an object with `id` and `type` fields to identify the selected item.
|
|
183
|
+
*/
|
|
55
184
|
selectedItem?: {
|
|
56
185
|
id: string;
|
|
57
186
|
type: string;
|
|
58
187
|
};
|
|
188
|
+
/**
|
|
189
|
+
* Fields that are read-only and cannot be modified by the user within the relationships properties panel
|
|
190
|
+
*/
|
|
191
|
+
readOnlyFields?: string[];
|
|
192
|
+
/**
|
|
193
|
+
* Fields that are hidden and cannot be seen by the user within the relationships properties panel
|
|
194
|
+
*/
|
|
195
|
+
hiddenFields?: string[];
|
|
196
|
+
/**
|
|
197
|
+
* Contains the data for a new page model, if applicable.
|
|
198
|
+
* Includes a `PageModelObjectData` object to represent the model structure.
|
|
199
|
+
*/
|
|
59
200
|
newPageModel?: {
|
|
60
201
|
model: PageModelObjectData;
|
|
61
202
|
};
|
|
203
|
+
/**
|
|
204
|
+
* Callback invoked when a link reason is selected.
|
|
205
|
+
* @param linkReason - The selected link reason.
|
|
206
|
+
*/
|
|
62
207
|
onLinkReasonSelected: (linkReason: Relationship) => void;
|
|
208
|
+
/**
|
|
209
|
+
* Represents the current field values of the relationship as key-value pairs.
|
|
210
|
+
*/
|
|
63
211
|
relationshipValues?: Record<string, any>;
|
|
212
|
+
/**
|
|
213
|
+
* Represents the initial field values used to populate the related object during creation.
|
|
214
|
+
*/
|
|
64
215
|
initialCreateData?: Record<string, any>;
|
|
216
|
+
/**
|
|
217
|
+
* Callback to set the API for the page viewer.
|
|
218
|
+
* Provides a `PageViewerAPI` instance to the component.
|
|
219
|
+
* @param api - The `PageViewerAPI` instance.
|
|
220
|
+
*/
|
|
65
221
|
setApi?: (api: PageViewerApi) => void;
|
|
222
|
+
/**
|
|
223
|
+
* Callback invoked when the related page changes.
|
|
224
|
+
* Triggered by events such as data updates or mode transitions.
|
|
225
|
+
* @param change - The event describing the change, either `PageDataChange` or `PageModeChange`.
|
|
226
|
+
*/
|
|
66
227
|
onRelatedPageChange?: (change: PageDataChange | PageModeChange) => void;
|
|
228
|
+
/**
|
|
229
|
+
* Callback invoked when the relationship values are updated.
|
|
230
|
+
* Provides both the current and previous values for comparison.
|
|
231
|
+
* @param current - The updated relationship values.
|
|
232
|
+
* @param previous - The previous relationship values, if available.
|
|
233
|
+
*/
|
|
67
234
|
onRelationshipValuesChange?: (current: Record<string, any>, previous?: Record<string, any>) => void;
|
|
68
235
|
}
|
|
69
236
|
export interface SearchInputInputBindings {
|
|
@@ -138,4 +305,4 @@ export interface TimeSliderBindings extends TimeSliderInputBindings {
|
|
|
138
305
|
onLoad?: () => void;
|
|
139
306
|
close?: () => void;
|
|
140
307
|
}
|
|
141
|
-
export type SviComponentBindings = ControlCollectionBindings | RelationshipDetailsBindings | SearchInputBindings |
|
|
308
|
+
export type SviComponentBindings = ControlCollectionBindings | RelationshipDetailsBindings | SearchInputBindings | PageViewerBindings | PagePreviewBindings | SearchAndSelectWithPreviewBindings | TimeSliderBindings;
|
package/component/bindings.js
CHANGED
|
@@ -1 +1,7 @@
|
|
|
1
|
-
export
|
|
1
|
+
export var PageViewerBindingsType;
|
|
2
|
+
(function (PageViewerBindingsType) {
|
|
3
|
+
PageViewerBindingsType["CreateObject"] = "CREATE";
|
|
4
|
+
PageViewerBindingsType["EditObject"] = "EDIT";
|
|
5
|
+
PageViewerBindingsType["ViewObject"] = "VIEW";
|
|
6
|
+
PageViewerBindingsType["StaticData"] = "STATIC";
|
|
7
|
+
})(PageViewerBindingsType || (PageViewerBindingsType = {}));
|
package/component/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ControlCollectionBindings,
|
|
1
|
+
import { ControlCollectionBindings, PagePreviewBindings, PageViewerBindings, RelationshipDetailsBindings, SearchAndSelectWithPreviewBindings, SearchInputBindings, SviComponentBindings, TimeSliderBindings } from "./bindings";
|
|
2
2
|
export declare enum SviComponent {
|
|
3
3
|
ControlCollection = "svi-control-collection",
|
|
4
4
|
RelationshipDetails = "svi-relationship-details",
|
|
@@ -24,7 +24,7 @@ export interface ComponentCreationResult<T> {
|
|
|
24
24
|
*/
|
|
25
25
|
export interface ComponentApi {
|
|
26
26
|
create(component: SviComponent.ControlCollection, target: HTMLElement, bindings?: ControlCollectionBindings): Promise<ComponentCreationResult<ControlCollectionBindings>>;
|
|
27
|
-
create(component: SviComponent.Page, target: HTMLElement, bindings?:
|
|
27
|
+
create(component: SviComponent.Page, target: HTMLElement, bindings?: PageViewerBindings): Promise<ComponentCreationResult<PageViewerBindings>>;
|
|
28
28
|
create(component: SviComponent.PagePreview, target: HTMLElement, bindings?: PagePreviewBindings): Promise<ComponentCreationResult<PagePreviewBindings>>;
|
|
29
29
|
create(component: SviComponent.RelationshipDetails, target: HTMLElement, bindings?: RelationshipDetailsBindings): Promise<ComponentCreationResult<RelationshipDetailsBindings>>;
|
|
30
30
|
create(component: SviComponent.SearchInput, target: HTMLElement, bindings?: SearchInputBindings): Promise<ComponentCreationResult<SearchInputBindings>>;
|
package/config/config-api.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { ControlMetadata
|
|
1
|
+
import { ControlMetadata } from "../svi-datahub";
|
|
2
2
|
import { ControlStates } from "../control/page";
|
|
3
|
+
import { ControlAttributeMap, IBaseControlAttribute, IGenericControlAttribute } from "./control-attribute-types";
|
|
3
4
|
export declare enum ControlType {
|
|
4
5
|
AngularJS = "angularjs",
|
|
5
6
|
Angular = "angular",
|
|
@@ -40,19 +41,7 @@ export interface SolutionExtensionConfigTypeAttributes {
|
|
|
40
41
|
metadata?: SolutionExtensionMetadata;
|
|
41
42
|
attributes?: Record<string, SolutionExtensionAttribute>;
|
|
42
43
|
}
|
|
43
|
-
export
|
|
44
|
-
type: string;
|
|
45
|
-
displayName: ResourcedString;
|
|
46
|
-
order?: number;
|
|
47
|
-
required?: boolean | string;
|
|
48
|
-
localizable?: boolean | string;
|
|
49
|
-
allowMultiple?: boolean | string;
|
|
50
|
-
states?: Record<string, boolean>;
|
|
51
|
-
defaultValue?: any;
|
|
52
|
-
disabledExpression?: string;
|
|
53
|
-
picklistName?: string;
|
|
54
|
-
ignoreRestrictions?: boolean;
|
|
55
|
-
}
|
|
44
|
+
export type SolutionExtensionAttribute = ControlAttributeMap[keyof ControlAttributeMap] | IBaseControlAttribute | IGenericControlAttribute;
|
|
56
45
|
export interface SolutionExtensionMetadata {
|
|
57
46
|
iconClass?: string;
|
|
58
47
|
useDragHandle?: boolean;
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import { StandardPropertyTypes } from "./standardPropertyTypes";
|
|
2
|
+
import { ResourcedString } from "../svi-datahub";
|
|
3
|
+
import { Status } from "./status";
|
|
4
|
+
export interface ControlAttributeMap<T = any> {
|
|
5
|
+
[StandardPropertyTypes.DataSource]: IControlAttributeDataSource;
|
|
6
|
+
[StandardPropertyTypes.RadioChooser]: ISpbRadioChooserAttribute<T>;
|
|
7
|
+
[StandardPropertyTypes.Picklist]: IControlAttributePicklist;
|
|
8
|
+
[StandardPropertyTypes.RadioSwitch]: IControlAttributeRadioSwitch;
|
|
9
|
+
[StandardPropertyTypes.StatusThresholdPicker]: IControlAttributeStatusThresholdPicker;
|
|
10
|
+
[StandardPropertyTypes.FileCategoryDataSource]: IControlAttributeFileCategoryDataSource;
|
|
11
|
+
[StandardPropertyTypes.MultiEditor]: IControlAttributeMultiEditor;
|
|
12
|
+
[StandardPropertyTypes.LinkedPage]: IControlAttributeLinkedPage;
|
|
13
|
+
[StandardPropertyTypes.InterpolatedTextInput]: IControlAttributeInterpolatedTextInput;
|
|
14
|
+
[StandardPropertyTypes.NumericRange]: IControlAttributeNumericRange;
|
|
15
|
+
[StandardPropertyTypes.ChartDataSource]: IControlAttributeChartDataSource;
|
|
16
|
+
[StandardPropertyTypes.HeightEditor]: IControlAttributeHeightEditor;
|
|
17
|
+
[StandardPropertyTypes.Checkbox]: IControlAttributeCheckbox;
|
|
18
|
+
[StandardPropertyTypes.RelationshipSummary]: IControlAttributeRelationshipSummary;
|
|
19
|
+
[StandardPropertyTypes.TextInput]: IControlAttributeTextInput;
|
|
20
|
+
[StandardPropertyTypes.TileProviderChooser]: IControlAttributeTileProviderChooser;
|
|
21
|
+
[StandardPropertyTypes.SeparatorStart]: IControlAttributeSeparatorStart;
|
|
22
|
+
[StandardPropertyTypes.Separator]: IControlAttributeSeparator;
|
|
23
|
+
[StandardPropertyTypes.ColumnDataType]: IControlAttributeColumnDataType;
|
|
24
|
+
}
|
|
25
|
+
export type UnmappedStandardPropertyTypes = Exclude<StandardPropertyTypes, keyof ControlAttributeMap>;
|
|
26
|
+
export interface IBaseControlAttribute {
|
|
27
|
+
type: UnmappedStandardPropertyTypes | `${UnmappedStandardPropertyTypes}`;
|
|
28
|
+
displayName: ResourcedString;
|
|
29
|
+
order?: number;
|
|
30
|
+
required?: boolean | string;
|
|
31
|
+
description?: ResourcedString;
|
|
32
|
+
localizable?: boolean | string;
|
|
33
|
+
defaultValue?: any;
|
|
34
|
+
migrationValue?: never;
|
|
35
|
+
disabledExpression?: string;
|
|
36
|
+
hiddenExpression?: string;
|
|
37
|
+
hideOnDisable?: boolean;
|
|
38
|
+
cssClass?: string;
|
|
39
|
+
triggerResizeOnChange?: boolean;
|
|
40
|
+
}
|
|
41
|
+
type BaseControlAttribute = Omit<IBaseControlAttribute, "type">;
|
|
42
|
+
export interface IGenericControlAttribute extends BaseControlAttribute {
|
|
43
|
+
type: string;
|
|
44
|
+
[key: string]: any;
|
|
45
|
+
}
|
|
46
|
+
export interface ISpbRadioChooserOption<T = any> {
|
|
47
|
+
value: T;
|
|
48
|
+
resourceKey: string;
|
|
49
|
+
}
|
|
50
|
+
export interface ISpbRadioChooserAttribute<T = any> extends Omit<BaseControlAttribute, "migrationValue"> {
|
|
51
|
+
type: StandardPropertyTypes.RadioChooser | `${StandardPropertyTypes.RadioChooser}`;
|
|
52
|
+
migrationValue?: T;
|
|
53
|
+
defaultValue?: T;
|
|
54
|
+
radioConfig: {
|
|
55
|
+
inline?: boolean;
|
|
56
|
+
options: Array<ISpbRadioChooserOption<T>>;
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
export interface IControlAttributeCheckbox extends Omit<BaseControlAttribute, "migrationValue"> {
|
|
60
|
+
type: StandardPropertyTypes.Checkbox | `${StandardPropertyTypes.Checkbox}`;
|
|
61
|
+
migrationValue?: boolean;
|
|
62
|
+
defaultValue?: boolean;
|
|
63
|
+
}
|
|
64
|
+
export interface IControlAttributePicklist extends BaseControlAttribute {
|
|
65
|
+
type: StandardPropertyTypes.Picklist | `${StandardPropertyTypes.Picklist}`;
|
|
66
|
+
picklistName: string;
|
|
67
|
+
noSelectionText?: ResourcedString;
|
|
68
|
+
relatedDataSource?: string;
|
|
69
|
+
}
|
|
70
|
+
export interface IControlAttributeDataSource extends BaseControlAttribute {
|
|
71
|
+
type: StandardPropertyTypes.DataSource | `${StandardPropertyTypes.DataSource}`;
|
|
72
|
+
limitDataSourceType?: string;
|
|
73
|
+
ignoreRestrictions?: boolean;
|
|
74
|
+
optional?: boolean;
|
|
75
|
+
}
|
|
76
|
+
interface RadioSwitchBaseOption {
|
|
77
|
+
default?: boolean;
|
|
78
|
+
iconClass: string;
|
|
79
|
+
value: any;
|
|
80
|
+
title: string;
|
|
81
|
+
}
|
|
82
|
+
export type RadioSwitchOption = RadioSwitchBaseOption | Omit<RadioSwitchBaseOption, "title"> | Omit<RadioSwitchBaseOption, "iconClass">;
|
|
83
|
+
export interface IControlAttributeRadioSwitch extends BaseControlAttribute {
|
|
84
|
+
type: StandardPropertyTypes.RadioSwitch | `${StandardPropertyTypes.RadioSwitch}`;
|
|
85
|
+
options: RadioSwitchOption[];
|
|
86
|
+
}
|
|
87
|
+
export interface IControlAttributeHeightEditor extends BaseControlAttribute {
|
|
88
|
+
type: StandardPropertyTypes.HeightEditor | `${StandardPropertyTypes.HeightEditor}`;
|
|
89
|
+
states?: {
|
|
90
|
+
hideResizeByContent?: boolean;
|
|
91
|
+
hideFill?: boolean;
|
|
92
|
+
hideFixed?: boolean;
|
|
93
|
+
};
|
|
94
|
+
labels?: {
|
|
95
|
+
fixed: string;
|
|
96
|
+
resize: string;
|
|
97
|
+
};
|
|
98
|
+
defaultValue?: string;
|
|
99
|
+
}
|
|
100
|
+
export interface IControlAttributeChartDataSource extends BaseControlAttribute {
|
|
101
|
+
type: StandardPropertyTypes.ChartDataSource | `${StandardPropertyTypes.ChartDataSource}`;
|
|
102
|
+
groupFieldHidden?: any;
|
|
103
|
+
valueFieldDisabledExpression?: string;
|
|
104
|
+
}
|
|
105
|
+
export interface IControlAttributeNumericRange extends BaseControlAttribute {
|
|
106
|
+
type: StandardPropertyTypes.NumericRange | `${StandardPropertyTypes.NumericRange}`;
|
|
107
|
+
min: number;
|
|
108
|
+
max: number;
|
|
109
|
+
defaultValue?: number;
|
|
110
|
+
}
|
|
111
|
+
export interface IControlAttributeLinkedPage extends BaseControlAttribute {
|
|
112
|
+
type: StandardPropertyTypes.LinkedPage | `${StandardPropertyTypes.LinkedPage}`;
|
|
113
|
+
allowNoDataSourcePages?: boolean;
|
|
114
|
+
}
|
|
115
|
+
export interface IControlAttributeMultiEditor extends BaseControlAttribute {
|
|
116
|
+
type: StandardPropertyTypes.MultiEditor | `${StandardPropertyTypes.MultiEditor}`;
|
|
117
|
+
editorAttributes: {
|
|
118
|
+
buttonText: ResourcedString;
|
|
119
|
+
category: "Container";
|
|
120
|
+
type: string;
|
|
121
|
+
typePlural: string;
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
export interface IControlAttributeFileCategoryDataSource extends Omit<IControlAttributeDataSource, "type"> {
|
|
125
|
+
type: StandardPropertyTypes.FileCategoryDataSource | `${StandardPropertyTypes.FileCategoryDataSource}`;
|
|
126
|
+
allowMultiple?: boolean | string;
|
|
127
|
+
}
|
|
128
|
+
export interface IControlAttributeStatusThresholdPicker extends BaseControlAttribute {
|
|
129
|
+
type: StandardPropertyTypes.StatusThresholdPicker | `${StandardPropertyTypes.StatusThresholdPicker}`;
|
|
130
|
+
thresholds: Array<{
|
|
131
|
+
color: Status;
|
|
132
|
+
label: string;
|
|
133
|
+
resourceKey: string;
|
|
134
|
+
lowerBound: number;
|
|
135
|
+
}>;
|
|
136
|
+
upperBound: number;
|
|
137
|
+
}
|
|
138
|
+
export interface IControlAttributeRelationshipSummary extends Omit<BaseControlAttribute, "displayName"> {
|
|
139
|
+
type: StandardPropertyTypes.RelationshipSummary | `${StandardPropertyTypes.RelationshipSummary}`;
|
|
140
|
+
displayName?: never;
|
|
141
|
+
}
|
|
142
|
+
export interface IControlAttributeTextInput extends BaseControlAttribute {
|
|
143
|
+
type: StandardPropertyTypes.TextInput | `${StandardPropertyTypes.TextInput}`;
|
|
144
|
+
defaultValue?: ResourcedString | string;
|
|
145
|
+
}
|
|
146
|
+
export interface IControlAttributeInterpolatedTextInput extends Omit<IControlAttributeTextInput, "type"> {
|
|
147
|
+
type: StandardPropertyTypes.InterpolatedTextInput | `${StandardPropertyTypes.InterpolatedTextInput}`;
|
|
148
|
+
interpolatedTextInputDialogTitle: ResourcedString;
|
|
149
|
+
}
|
|
150
|
+
export interface IControlAttributeTileProviderChooser extends BaseControlAttribute {
|
|
151
|
+
type: StandardPropertyTypes.TileProviderChooser | `${StandardPropertyTypes.TileProviderChooser}`;
|
|
152
|
+
optional?: boolean;
|
|
153
|
+
}
|
|
154
|
+
export interface IControlAttributeSeparatorStart extends Omit<BaseControlAttribute, "displayName"> {
|
|
155
|
+
displayName?: never;
|
|
156
|
+
separatorLabel?: ResourcedString;
|
|
157
|
+
type: StandardPropertyTypes.SeparatorStart | `${StandardPropertyTypes.SeparatorStart}`;
|
|
158
|
+
}
|
|
159
|
+
export interface IControlAttributeSeparator extends Omit<BaseControlAttribute, "displayName"> {
|
|
160
|
+
displayName?: never;
|
|
161
|
+
separatorLabel?: ResourcedString;
|
|
162
|
+
type: StandardPropertyTypes.Separator | `${StandardPropertyTypes.Separator}`;
|
|
163
|
+
}
|
|
164
|
+
export interface IControlAttributeColumnDataType extends Omit<BaseControlAttribute, "displayName"> {
|
|
165
|
+
displayName?: never;
|
|
166
|
+
type: StandardPropertyTypes.ColumnDataType | `${StandardPropertyTypes.ColumnDataType}`;
|
|
167
|
+
}
|
|
168
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import { StandardPropertyTypes } from "./standardPropertyTypes";
|
package/config/index.d.ts
CHANGED
package/config/index.js
CHANGED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
export declare enum StandardPropertyTypes {
|
|
2
|
+
Checkbox = "Checkbox",
|
|
3
|
+
ColumnDataType = "ColumnDataType",
|
|
4
|
+
RadioChooser = "RadioChooser",
|
|
5
|
+
ColumnEditor = "ColumnEditor",
|
|
6
|
+
ColumnGroup = "ColumnGroup",
|
|
7
|
+
ColumnsEditor = "ColumnsEditor",
|
|
8
|
+
DataSource = "DataSource",
|
|
9
|
+
EntityChooser = "EntityChooser",
|
|
10
|
+
EntityScorecard = "EntityScorecard",
|
|
11
|
+
FormSearchEntityChooser = "FormSearchEntityChooser",
|
|
12
|
+
FileCategoryDataSource = "FileCategoryDataSource",
|
|
13
|
+
GroupChooser = "GroupChooser",
|
|
14
|
+
HeightEditor = "HeightEditor",
|
|
15
|
+
InlineStoredFile = "InlineStoredFile",
|
|
16
|
+
InterpolatedTextEditor = "InterpolatedTextEditor",
|
|
17
|
+
InterpolatedTextInput = "InterpolatedTextInput",
|
|
18
|
+
LinkedObjectDataSource = "LinkedObjectDataSource",
|
|
19
|
+
LinkedObjectFields = "LinkedObjectFields",
|
|
20
|
+
LinkedPage = "LinkedPage",
|
|
21
|
+
LinkedRecordSummaryResultEntities = "LinkedRecordSummaryResultEntities",
|
|
22
|
+
MultiEditor = "MultiEditor",
|
|
23
|
+
NumericRange = "NumericRange",
|
|
24
|
+
ObjectLabelEditor = "ObjectLabelEditor",
|
|
25
|
+
Picklist = "Picklist",
|
|
26
|
+
RelationshipMulti = "RelationshipMulti",
|
|
27
|
+
RelationshipSummary = "RelationshipSummary",
|
|
28
|
+
RendererPanel = "RendererPanel",
|
|
29
|
+
ReadOnly = "ReadOnly",
|
|
30
|
+
Required = "Required",
|
|
31
|
+
Separator = "Separator",
|
|
32
|
+
SeparatorStart = "SeparatorStart",
|
|
33
|
+
SlidingScale = "SlidingScale",
|
|
34
|
+
SubDocumentDataSource = "SubDocumentDataSource",
|
|
35
|
+
SubDocumentDualAxisGraph = "SubDocumentDualAxisGraph",
|
|
36
|
+
TextInput = "TextInput",
|
|
37
|
+
Traversal = "Traversal",
|
|
38
|
+
TraversalMulti = "TraversalMulti",
|
|
39
|
+
CreateContextSelect = "CreateContextSelect",
|
|
40
|
+
ChartDataSource = "ChartDataSource",
|
|
41
|
+
ReportDataSourceChooser = "ReportDataSourceChooser",
|
|
42
|
+
RadioSwitch = "RadioSwitch",
|
|
43
|
+
Thresholds = "Thresholds",
|
|
44
|
+
UserGroupChooser = "UserGroupChooser",
|
|
45
|
+
TileProviderChooser = "TileProviderChooser",
|
|
46
|
+
StatusThresholdPicker = "StatusThresholdPicker",
|
|
47
|
+
Hidden = "Hidden",
|
|
48
|
+
Disabled = "Disabled",
|
|
49
|
+
Condition = "Condition"
|
|
50
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
// internal control property/typeAttribute types
|
|
2
|
+
export var StandardPropertyTypes;
|
|
3
|
+
(function (StandardPropertyTypes) {
|
|
4
|
+
StandardPropertyTypes["Checkbox"] = "Checkbox";
|
|
5
|
+
StandardPropertyTypes["ColumnDataType"] = "ColumnDataType";
|
|
6
|
+
StandardPropertyTypes["RadioChooser"] = "RadioChooser";
|
|
7
|
+
StandardPropertyTypes["ColumnEditor"] = "ColumnEditor";
|
|
8
|
+
StandardPropertyTypes["ColumnGroup"] = "ColumnGroup";
|
|
9
|
+
StandardPropertyTypes["ColumnsEditor"] = "ColumnsEditor";
|
|
10
|
+
StandardPropertyTypes["DataSource"] = "DataSource";
|
|
11
|
+
StandardPropertyTypes["EntityChooser"] = "EntityChooser";
|
|
12
|
+
StandardPropertyTypes["EntityScorecard"] = "EntityScorecard";
|
|
13
|
+
StandardPropertyTypes["FormSearchEntityChooser"] = "FormSearchEntityChooser";
|
|
14
|
+
StandardPropertyTypes["FileCategoryDataSource"] = "FileCategoryDataSource";
|
|
15
|
+
StandardPropertyTypes["GroupChooser"] = "GroupChooser";
|
|
16
|
+
StandardPropertyTypes["HeightEditor"] = "HeightEditor";
|
|
17
|
+
StandardPropertyTypes["InlineStoredFile"] = "InlineStoredFile";
|
|
18
|
+
StandardPropertyTypes["InterpolatedTextEditor"] = "InterpolatedTextEditor";
|
|
19
|
+
StandardPropertyTypes["InterpolatedTextInput"] = "InterpolatedTextInput";
|
|
20
|
+
StandardPropertyTypes["LinkedObjectDataSource"] = "LinkedObjectDataSource";
|
|
21
|
+
StandardPropertyTypes["LinkedObjectFields"] = "LinkedObjectFields";
|
|
22
|
+
StandardPropertyTypes["LinkedPage"] = "LinkedPage";
|
|
23
|
+
StandardPropertyTypes["LinkedRecordSummaryResultEntities"] = "LinkedRecordSummaryResultEntities";
|
|
24
|
+
StandardPropertyTypes["MultiEditor"] = "MultiEditor";
|
|
25
|
+
StandardPropertyTypes["NumericRange"] = "NumericRange";
|
|
26
|
+
StandardPropertyTypes["ObjectLabelEditor"] = "ObjectLabelEditor";
|
|
27
|
+
StandardPropertyTypes["Picklist"] = "Picklist";
|
|
28
|
+
StandardPropertyTypes["RelationshipMulti"] = "RelationshipMulti";
|
|
29
|
+
StandardPropertyTypes["RelationshipSummary"] = "RelationshipSummary";
|
|
30
|
+
StandardPropertyTypes["RendererPanel"] = "RendererPanel";
|
|
31
|
+
StandardPropertyTypes["ReadOnly"] = "ReadOnly";
|
|
32
|
+
StandardPropertyTypes["Required"] = "Required";
|
|
33
|
+
StandardPropertyTypes["Separator"] = "Separator";
|
|
34
|
+
StandardPropertyTypes["SeparatorStart"] = "SeparatorStart";
|
|
35
|
+
StandardPropertyTypes["SlidingScale"] = "SlidingScale";
|
|
36
|
+
StandardPropertyTypes["SubDocumentDataSource"] = "SubDocumentDataSource";
|
|
37
|
+
StandardPropertyTypes["SubDocumentDualAxisGraph"] = "SubDocumentDualAxisGraph";
|
|
38
|
+
StandardPropertyTypes["TextInput"] = "TextInput";
|
|
39
|
+
StandardPropertyTypes["Traversal"] = "Traversal";
|
|
40
|
+
StandardPropertyTypes["TraversalMulti"] = "TraversalMulti";
|
|
41
|
+
StandardPropertyTypes["CreateContextSelect"] = "CreateContextSelect";
|
|
42
|
+
StandardPropertyTypes["ChartDataSource"] = "ChartDataSource";
|
|
43
|
+
StandardPropertyTypes["ReportDataSourceChooser"] = "ReportDataSourceChooser";
|
|
44
|
+
StandardPropertyTypes["RadioSwitch"] = "RadioSwitch";
|
|
45
|
+
StandardPropertyTypes["Thresholds"] = "Thresholds";
|
|
46
|
+
StandardPropertyTypes["UserGroupChooser"] = "UserGroupChooser";
|
|
47
|
+
StandardPropertyTypes["TileProviderChooser"] = "TileProviderChooser";
|
|
48
|
+
StandardPropertyTypes["StatusThresholdPicker"] = "StatusThresholdPicker";
|
|
49
|
+
StandardPropertyTypes["Hidden"] = "Hidden";
|
|
50
|
+
StandardPropertyTypes["Disabled"] = "Disabled";
|
|
51
|
+
StandardPropertyTypes["Condition"] = "Condition";
|
|
52
|
+
})(StandardPropertyTypes || (StandardPropertyTypes = {}));
|