@sassoftware/vi-api 1.46.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.
@@ -1,6 +1,6 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
- // Generated using typescript-generator version 2.15.527 on 2025-02-05 14:39:22.
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,6 +115,9 @@ export interface AlertRep extends BaseRep {
115
115
  autoActivateScore?: number;
116
116
  strategyRangeLow?: number;
117
117
  strategyRangeHigh?: number;
118
+ dispositionTimestamp?: string;
119
+ suppressionEndTimestamp?: string;
120
+ holdEndTimestamp?: string;
118
121
  queueEntryTimestamp?: string;
119
122
  assignmentTimestamp?: string;
120
123
  checkoutTimestamp?: string;
@@ -124,9 +127,6 @@ export interface AlertRep extends BaseRep {
124
127
  autoActivateTimestamp?: string;
125
128
  alertVersionTimestamp?: string;
126
129
  statusTimestamp?: string;
127
- dispositionTimestamp?: string;
128
- suppressionEndTimestamp?: string;
129
- holdEndTimestamp?: string;
130
130
  }
131
131
 
132
132
  export interface AlertVersionSummaryRep {
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@types/alert-reps",
3
- "version": "20.2.2",
3
+ "version": "20.4.2",
4
4
  "types": "index.d.ts"
5
5
  }
@@ -153,24 +153,84 @@ export interface ControlCollectionBindings {
153
153
  pageModel?: PageModel;
154
154
  root?: boolean;
155
155
  }
156
+ /**
157
+ * Defines the bindings for managing relationship details in a component.
158
+ */
156
159
  export interface RelationshipDetailsBindings {
160
+ /**
161
+ * Defines the identifier of the target object type that the relationship references.
162
+ */
157
163
  targetObjectTypeName: string;
164
+ /**
165
+ * Defines the display label of the target object type.
166
+ */
158
167
  targetObjectTypeLabel: string;
168
+ /**
169
+ * Defines the identifier of the parent object type that owns the relationship.
170
+ */
159
171
  parentObjectTypeName: string;
172
+ /**
173
+ * Specifies the user-friendly label of the parent object type.
174
+ */
160
175
  parentObjectTypeLabel: string;
176
+ /**
177
+ * Represents the list of reasons that define the purpose or context of the relationship.
178
+ */
161
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
+ */
162
184
  selectedItem?: {
163
185
  id: string;
164
186
  type: string;
165
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
+ */
166
200
  newPageModel?: {
167
201
  model: PageModelObjectData;
168
202
  };
203
+ /**
204
+ * Callback invoked when a link reason is selected.
205
+ * @param linkReason - The selected link reason.
206
+ */
169
207
  onLinkReasonSelected: (linkReason: Relationship) => void;
208
+ /**
209
+ * Represents the current field values of the relationship as key-value pairs.
210
+ */
170
211
  relationshipValues?: Record<string, any>;
212
+ /**
213
+ * Represents the initial field values used to populate the related object during creation.
214
+ */
171
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
+ */
172
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
+ */
173
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
+ */
174
234
  onRelationshipValuesChange?: (current: Record<string, any>, previous?: Record<string, any>) => void;
175
235
  }
176
236
  export interface SearchInputInputBindings {
@@ -6,7 +6,6 @@ import { Control, RefreshablePageControlOptions, SlidingPanelContent, SlidingPan
6
6
  import { FieldTypeToRestrictions, FileRestrictions } from "./restrictions";
7
7
  import { AttachmentFormData } from "./file";
8
8
  import { MaskingControlApi, MaskingPageApi } from "./masking-api";
9
- import { IControlClientStates } from "../../spb/page-viewer/control-member/api/control-state-api";
10
9
  /**
11
10
  * The minimum API that should be supported on control members across solutions.
12
11
  */
@@ -204,7 +203,7 @@ export interface ControlStateApi {
204
203
  * @param state {string} The key of the state to be returned.
205
204
  * @returns The specified state of the calling control, or undefined if no match.
206
205
  */
207
- get<T extends keyof IControlClientStates>(state: T): boolean | undefined;
206
+ get<T extends keyof ControlClientStates>(state: T): boolean | undefined;
208
207
  /**
209
208
  * Registers a function to be invoked whenever a state change event occurs.
210
209
  * This function receives an object that contains information about the change event.
@@ -541,3 +540,45 @@ export interface FieldNotOnPageError {
541
540
  message: string;
542
541
  fields: string[];
543
542
  }
543
+ /**
544
+ * Represents the client states of a control.
545
+ */
546
+ export interface ControlClientStates {
547
+ /**
548
+ * Indicates if the control is required.
549
+ */
550
+ required: boolean;
551
+ /**
552
+ * Indicates if the control is read-only.
553
+ */
554
+ readOnly: boolean;
555
+ /**
556
+ * Indicates if the control is hidden.
557
+ */
558
+ hidden: boolean;
559
+ /**
560
+ * Indicates if the control allows input.
561
+ */
562
+ allowInput: boolean;
563
+ /**
564
+ * Indicates if the control could potentially be read-only
565
+ */
566
+ couldBeReadOnly: boolean;
567
+ /**
568
+ * Indicates if the control could potentially be required
569
+ */
570
+ couldBeRequired: boolean;
571
+ /**
572
+ * Indicates if the control is disabled.
573
+ */
574
+ disabled: boolean;
575
+ /**
576
+ * Indicates if the control has masking active.
577
+ * @deprecated Use `api.control.masking.isMasked` instead.
578
+ */
579
+ maskActive: boolean;
580
+ /**
581
+ * A dynamic map of additional states, where the key is the state name and the value is a boolean.
582
+ */
583
+ [state: string]: boolean;
584
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sassoftware/vi-api",
3
- "version": "1.46.0",
3
+ "version": "1.48.0",
4
4
  "description": "Types used in the SAS Visual Investigator API",
5
5
  "keywords": [
6
6
  "SAS",
@@ -1,6 +1,6 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
- // Generated using typescript-generator version 2.15.527 on 2025-02-05 14:45:29.
3
+ // Generated using typescript-generator version 2.15.527 on 2025-04-07 09:10:17.
4
4
 
5
5
  export interface BaseRep extends TrackedResource {
6
6
  links?: Link[];
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@types/score-reps",
3
- "version": "8.1.2",
3
+ "version": "8.3.2",
4
4
  "types": "index.d.ts"
5
5
  }
@@ -71,6 +71,13 @@ export interface SviShellTabData {
71
71
  * { and: ["svi-alert", "documentGeneratorAdapter"] }
72
72
  */
73
73
  requiredServices?: RequiredResourcesExpression;
74
+ /**
75
+ * Set to true if the tab visibility depends on CAS being enabled.
76
+ * If CAS is enabled, the tab will show. If CAS is disabled, the tab will be
77
+ * hidden and cannot be navigated to. If set to false/undefined (default),
78
+ * the tab will show regardless of whether CAS is enabled.
79
+ */
80
+ CASSensitive?: boolean;
74
81
  [key: string]: any;
75
82
  }
76
83
  export interface ExternalTabConfig<T = SviShellTabData, P = any> {
@@ -1,6 +1,6 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
- // Generated using typescript-generator version 2.15.527 on 2025-02-05 16:08:26.
3
+ // Generated using typescript-generator version 2.15.527 on 2025-04-09 14:11:38.
4
4
 
5
5
  export interface SecuredApiMeta {
6
6
  experimental?: boolean;
@@ -13,10 +13,10 @@ export interface SecuredApiMeta {
13
13
  }
14
14
 
15
15
  export interface SecuredBuild {
16
- buildVersion?: string;
17
- applicationVersion?: string;
18
16
  sourceId?: string;
19
17
  sourceTimeStamp?: string;
18
+ applicationVersion?: string;
19
+ buildVersion?: string;
20
20
  timeStamp?: string;
21
21
  }
22
22
 
@@ -47,10 +47,10 @@ export interface ResourceMediaTypes {
47
47
  }
48
48
 
49
49
  export interface Build extends Serializable {
50
- buildVersion?: string;
51
- applicationVersion?: string;
52
50
  sourceId?: string;
53
51
  sourceTimeStamp?: string;
52
+ buildVersion?: string;
53
+ applicationVersion?: string;
54
54
  timeStamp?: string;
55
55
  }
56
56
 
@@ -401,6 +401,10 @@ export interface SolutionPublishResultDTO {
401
401
  links?: RestRepresentationsLink[];
402
402
  }
403
403
 
404
+ export interface AccessController {
405
+ allRules?: ResponseEntity<EntityLevelRules[]>;
406
+ }
407
+
404
408
  export interface AttachmentController {
405
409
  }
406
410
 
@@ -774,8 +778,8 @@ export interface CoreRelationship extends CoreDataObjectWithHistory {
774
778
  nonAttributeFieldNames?: string[];
775
779
  foreignKeyFieldNames?: string[];
776
780
  reverseLabel?: string;
777
- link?: boolean;
778
781
  qualifiedName?: string;
782
+ link?: boolean;
779
783
  readOnly?: boolean;
780
784
  }
781
785
 
@@ -1720,6 +1724,12 @@ export interface ElementConverter extends LocalizableObjectConversionProcessor<C
1720
1724
  export interface EntityConverter extends LocalizableObjectConversionProcessor<CoreEntity, EntityDTO>, MetadataConverter<CoreEntity, EntityDTO> {
1721
1725
  }
1722
1726
 
1727
+ export interface EntityLevelRuleDescriptorConverter extends MetadataConverter<EntityLevelRuleDescriptor, EntityLevelRuleDescriptorConfigDTO> {
1728
+ }
1729
+
1730
+ export interface EntityLevelRulesConverter extends MetadataConverter<EntityLevelRules, EntityLevelRulesConfigDTO> {
1731
+ }
1732
+
1723
1733
  export interface EntityTypeConverter extends DataObjectConversionProcessor<CoreStoredObject, StoredObjectDTO>, MetadataConverter<CoreStoredObject, StoredObjectDTO> {
1724
1734
  }
1725
1735
 
@@ -2251,6 +2261,9 @@ export interface DocumentTypeWithClientApplication {
2251
2261
  export interface ElementExportDTO extends ElementDTO {
2252
2262
  }
2253
2263
 
2264
+ export interface ElsQuerySerializer extends JsonSerializer<any> {
2265
+ }
2266
+
2254
2267
  export interface EmbeddedElementExportDTO extends ElementDTO {
2255
2268
  }
2256
2269
 
@@ -2264,6 +2277,19 @@ export interface EntityExportDTO extends EntityDTO {
2264
2277
  iconDecoration?: string;
2265
2278
  }
2266
2279
 
2280
+ export interface EntityLevelRuleDescriptorConfigDTO {
2281
+ group?: string;
2282
+ permissions?: { [index: string]: boolean };
2283
+ conditions?: any;
2284
+ conditionName?: string;
2285
+ }
2286
+
2287
+ export interface EntityLevelRulesConfigDTO {
2288
+ rules?: EntityLevelRuleDescriptorConfigDTO[];
2289
+ version?: number;
2290
+ name?: string;
2291
+ }
2292
+
2267
2293
  export interface GroupedContextMappingConfigurationDTO extends DocumentTypeWithClientApplication, Comparable<GroupedContextMappingConfigurationDTO>, SolutionAssignedDTO {
2268
2294
  mappings?: ContextMappingConfigurationDTO[];
2269
2295
  documentTypeLabel?: string;
@@ -2293,6 +2319,7 @@ export interface MetadataExportDTO extends ConfigTransportObject {
2293
2319
  actions?: PageAction[];
2294
2320
  actionItems?: ActionConfigurationDTO[];
2295
2321
  hierarchicalReferenceData?: CascadingReferenceDataDTO[];
2322
+ rules?: EntityLevelRulesConfigDTO[];
2296
2323
  }
2297
2324
 
2298
2325
  export interface StoredObjectExportDTO extends StoredObjectDTO {
@@ -2695,10 +2722,10 @@ export interface DataField {
2695
2722
  primaryKeyField?: boolean;
2696
2723
  displayIndex?: number;
2697
2724
  primaryKeySeqNo?: number;
2725
+ allowMultipleSelections?: boolean;
2698
2726
  unique?: boolean;
2699
2727
  autoGenerated?: boolean;
2700
2728
  systemReserved?: boolean;
2701
- allowMultipleSelections?: boolean;
2702
2729
  userSelectionStrategy?: UserSelectionStrategyType;
2703
2730
  constrainingListName?: string;
2704
2731
  indexedForSearch?: boolean;
@@ -2877,9 +2904,9 @@ export interface Relationship extends DataObject {
2877
2904
  joinTableName?: string;
2878
2905
  required?: boolean;
2879
2906
  qualifiedName?: string;
2880
- color?: string;
2881
- managed?: boolean;
2882
2907
  summaryFields?: SortableNameReference[];
2908
+ managed?: boolean;
2909
+ color?: string;
2883
2910
  width?: number;
2884
2911
  type?: RelationshipType;
2885
2912
  }
@@ -3849,6 +3876,7 @@ export interface ValueInstantiator {
3849
3876
  }
3850
3877
 
3851
3878
  export interface JavaType extends ResolvedType, Serializable, Type {
3879
+ javaLangObject?: boolean;
3852
3880
  recordType?: boolean;
3853
3881
  typeHandler?: any;
3854
3882
  valueHandler?: any;
@@ -3858,12 +3886,11 @@ export interface JavaType extends ResolvedType, Serializable, Type {
3858
3886
  contentTypeHandler?: any;
3859
3887
  erasedSignature?: string;
3860
3888
  superClass?: JavaType;
3861
- javaLangObject?: boolean;
3862
3889
  keyType?: JavaType;
3863
3890
  interfaces?: JavaType[];
3864
3891
  genericSignature?: string;
3865
- bindings?: TypeBindings;
3866
3892
  contentType?: JavaType;
3893
+ bindings?: TypeBindings;
3867
3894
  }
3868
3895
 
3869
3896
  export interface JsonDeserializer<T> extends NullValueProvider {
@@ -3890,6 +3917,15 @@ export interface JsonSerializer<T> extends JsonFormatVisitable {
3890
3917
  delegatee?: JsonSerializer<any>;
3891
3918
  }
3892
3919
 
3920
+ export interface ResponseEntity<T> extends HttpEntity<T> {
3921
+ statusCodeValue?: number;
3922
+ statusCode?: HttpStatusCode;
3923
+ }
3924
+
3925
+ export interface EntityLevelRules extends Rule, ETaggable, ConfigurationItemRepresentation<EntityLevelRuleDescriptor[], ConfigItemMetadataHolder> {
3926
+ rules?: EntityLevelRuleDescriptor[];
3927
+ }
3928
+
3893
3929
  export interface HandlerExceptionResolver {
3894
3930
  }
3895
3931
 
@@ -3897,11 +3933,6 @@ export interface Ordered {
3897
3933
  order?: number;
3898
3934
  }
3899
3935
 
3900
- export interface ResponseEntity<T> extends HttpEntity<T> {
3901
- statusCodeValue?: number;
3902
- statusCode?: HttpStatusCode;
3903
- }
3904
-
3905
3936
  export interface LocalizedLocale {
3906
3937
  localeCd?: string;
3907
3938
  label?: string;
@@ -4164,6 +4195,18 @@ export interface HttpStatusCode extends Serializable {
4164
4195
  error?: boolean;
4165
4196
  }
4166
4197
 
4198
+ export interface EntityLevelRuleDescriptor extends Comparable<EntityLevelRuleDescriptor> {
4199
+ group?: string;
4200
+ permissions?: { [index: string]: boolean };
4201
+ conditions?: any;
4202
+ conditionName?: string;
4203
+ }
4204
+
4205
+ export interface Rule {
4206
+ version?: number;
4207
+ name?: string;
4208
+ }
4209
+
4167
4210
  export interface ConditionEntity extends Mergable<ConditionEntity> {
4168
4211
  id?: string;
4169
4212
  name?: string;
@@ -4278,9 +4321,6 @@ export interface OfField<F> extends TypeDescriptor {
4278
4321
  primitive?: boolean;
4279
4322
  }
4280
4323
 
4281
- export interface AnnotationMap extends Annotations {
4282
- }
4283
-
4284
4324
  export interface TypeResolutionContext {
4285
4325
  }
4286
4326
 
@@ -4291,20 +4331,23 @@ export interface Member {
4291
4331
  declaringClass?: Class<any>;
4292
4332
  }
4293
4333
 
4334
+ export interface AnnotationMap extends Annotations {
4335
+ }
4336
+
4294
4337
  export interface AnnotatedMember extends Annotated, Serializable {
4295
- allAnnotations?: AnnotationMap;
4296
4338
  typeContext?: TypeResolutionContext;
4297
4339
  member?: Member;
4298
4340
  declaringClass?: Class<any>;
4299
4341
  fullName?: string;
4342
+ allAnnotations?: AnnotationMap;
4300
4343
  }
4301
4344
 
4302
4345
  export interface ObjectIdInfo {
4303
4346
  generatorType?: Class<ObjectIdGenerator<any>>;
4304
4347
  resolverType?: Class<ObjectIdResolver>;
4305
4348
  alwaysAsId?: boolean;
4306
- propertyName?: PropertyName;
4307
4349
  scope?: Class<any>;
4350
+ propertyName?: PropertyName;
4308
4351
  }
4309
4352
 
4310
4353
  export interface TypeDeserializer {
@@ -4339,6 +4382,14 @@ export interface HttpEntity<T> {
4339
4382
  body?: T;
4340
4383
  }
4341
4384
 
4385
+ export interface ConfigurationItemRepresentation<T, R> {
4386
+ }
4387
+
4388
+ export interface ConfigItemMetadataHolder {
4389
+ solutionName?: string;
4390
+ parentReference?: any;
4391
+ }
4392
+
4342
4393
  export interface ConditionReferenceEntity {
4343
4394
  referencedCondition?: string;
4344
4395
  }
@@ -4459,8 +4510,8 @@ export interface Annotated {
4459
4510
  }
4460
4511
 
4461
4512
  export interface TypeIdResolver {
4462
- descForKnownTypeIds?: string;
4463
4513
  mechanism?: Id;
4514
+ descForKnownTypeIds?: string;
4464
4515
  }
4465
4516
 
4466
4517
  export interface MergeInfo {
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@types/svi-datahub",
3
- "version": "17.35.23",
3
+ "version": "17.37.45",
4
4
  "types": "index.d.ts"
5
5
  }
@@ -1,6 +1,6 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
- // Generated using typescript-generator version 2.15.527 on 2025-02-05 14:44:02.
3
+ // Generated using typescript-generator version 2.15.527 on 2025-04-07 09:10:59.
4
4
 
5
5
  export interface ApplicationSetting extends ResponsesErrorResponse {
6
6
  name?: string;
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@types/svi-sand",
3
- "version": "18.1.3",
3
+ "version": "18.3.5",
4
4
  "types": "index.d.ts"
5
5
  }