@sassoftware/vi-api 1.40.3 → 1.42.0

package/svi-datahub/index.d.ts

@@ -1,22 +1,22 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2024-05-02 10:44:28.
+// Generated using typescript-generator version 2.15.527 on 2024-05-01 20:09:23.
 
 export interface SecuredApiMeta {
     build?: SecuredBuild;
     apiVersion?: number;
-    experimental?: boolean;
-    applicationVersion?: string;
-    serviceId?: string;
     developmentStartYear?: number;
+    serviceId?: string;
+    experimental?: boolean;
     developmentEndYear?: number;
+    applicationVersion?: string;
 }
 
 export interface SecuredBuild {
-    sourceId?: string;
-    applicationVersion?: string;
     buildVersion?: string;
+    sourceId?: string;
     sourceTimeStamp?: string;
+    applicationVersion?: string;
     timeStamp?: string;
 }
 
@@ -28,9 +28,9 @@ export interface Api extends Serializable {
 export interface ApiMeta extends Serializable {
     build?: Build;
     apiVersion?: number;
-    experimental?: boolean;
-    serviceId?: string;
     developmentStartYear?: number;
+    serviceId?: string;
+    experimental?: boolean;
     developmentEndYear?: number;
 }
 
@@ -48,10 +48,10 @@ export interface ResourceMediaTypes {
 
 export interface Build extends Serializable {
     timeStamp?: string;
-    sourceId?: string;
-    applicationVersion?: string;
     buildVersion?: string;
+    sourceId?: string;
     sourceTimeStamp?: string;
+    applicationVersion?: string;
 }
 
 export interface Count extends Serializable {
@@ -761,13 +761,13 @@ export interface CoreRelationship extends CoreDataObjectWithHistory {
     readOnly?: boolean;
     qualifiedName?: string;
     link?: boolean;
-    internalHeterogeneous?: boolean;
-    reverseLabel?: string;
+    heterogeneous?: boolean;
     primaryKeyFields?: CoreRelationshipField[];
     attributeFields?: CoreRelationshipField[];
     nonAttributeFieldNames?: string[];
     foreignKeyFieldNames?: string[];
-    heterogeneous?: boolean;
+    internalHeterogeneous?: boolean;
+    reverseLabel?: string;
 }
 
 export interface CoreRelationshipField extends CoreDataField<CoreRelationship> {
@@ -809,9 +809,9 @@ export interface CoreStoredObject extends CoreDataObjectWithHistory {
     publishCode?: PublishCode;
     fieldMap?: { [index: string]: CoreStoredObjectField };
     readOnly?: boolean;
+    primaryKeyFields?: CoreStoredObjectField[];
     quotedDeleteTableName?: string;
     urnsequential?: boolean;
-    primaryKeyFields?: CoreStoredObjectField[];
 }
 
 export interface CoreStoredObjectField extends CoreDataField<CoreStoredObject> {
@@ -842,14 +842,14 @@ export interface CoreTransaction extends CoreDataObject {
     lineWidthFunctionType?: AggregateFunctionType;
     lineColorFieldName?: string;
     lineColorFunctionType?: AggregateFunctionType;
+    toHeterogeneousAndFromObjectIsIndexable?: boolean;
+    heterogeneous?: boolean;
+    primaryKeyFields?: CoreDataField<any>[];
+    toHeterogeneous?: boolean;
+    fromHeterogeneous?: boolean;
     fullHeterogeneous?: boolean;
     fromHeterogeneousAndToObjectIsIndexable?: boolean;
     nonHeterogeneousAndBothSidesAreIndexable?: boolean;
-    toHeterogeneous?: boolean;
-    fromHeterogeneous?: boolean;
-    toHeterogeneousAndFromObjectIsIndexable?: boolean;
-    primaryKeyFields?: CoreDataField<any>[];
-    heterogeneous?: boolean;
 }
 
 export interface CoreTransactionField extends CoreDataField<CoreTransaction> {
@@ -2461,8 +2461,8 @@ export interface DatahubQuery {
     includeAuditObjects?: boolean;
     dataMaskingStrategy?: DataMaskingStrategy;
     filterInternalChildEntityAuditFields?: boolean;
-    selectAll?: boolean;
     selectColumnFields?: string[];
+    selectAll?: boolean;
 }
 
 export interface EmptyResultsWherePredicate extends WherePredicate {
@@ -2685,9 +2685,8 @@ export interface DataField {
     columnName?: string;
     scale?: number;
     label?: string;
-    redacted?: AbstractRedactionRuleUnion;
-    ownerName?: string;
-    currentUserIsAuthorizedToReveal?: boolean;
+    dataType?: any;
+    primaryKeyField?: boolean;
     allowMultipleSelections?: boolean;
     displayIndex?: number;
     primaryKeySeqNo?: number;
@@ -2701,11 +2700,12 @@ export interface DataField {
     displayInTimeZone?: string;
     showTimeZone?: boolean;
     masked?: boolean;
-    primaryKeyField?: boolean;
+    authorizedToRevealMasked?: UserGroupChooserSelection[];
+    redacted?: AbstractRedactionRuleUnion;
     requiredConditionally?: ConditionalRule;
     readOnlyConditionally?: ConditionalRule;
-    authorizedToRevealMasked?: UserGroupChooserSelection[];
-    dataType?: any;
+    ownerName?: string;
+    currentUserIsAuthorizedToReveal?: boolean;
     description?: string;
 }
 
@@ -2717,17 +2717,17 @@ export interface DataObject extends SolutionAssignedDTO {
     version?: number;
     tableName?: string;
     label?: string;
-    historyEnabled?: boolean;
     createdAtTimeFieldName?: string;
-    dataStoreName?: string;
-    dataStoreDefaultSchemaName?: string;
-    dataStoreAssignedTimeZone?: string;
+    validFromFieldName?: string;
     systemReserved?: boolean;
     allowedRedactedFieldGroups?: string[];
-    validFromFieldName?: string;
     validToFieldName?: string;
     lastUpdatedAtTimeFieldName?: string;
     displayTextFields?: SortableNameReference[];
+    dataStoreName?: string;
+    dataStoreDefaultSchemaName?: string;
+    dataStoreAssignedTimeZone?: string;
+    historyEnabled?: boolean;
     description?: string;
 }
 
@@ -2776,20 +2776,20 @@ export interface Entity extends SolutionAssignedDTO {
     id?: number;
     scale?: number;
     label?: string;
+    defaultRegularIcon?: Icon;
     nodeColor?: string;
     nodeShape?: string;
     markerColor?: string;
     borderColor?: string;
     borderWidth?: number;
+    compounds?: Compound[];
     useForNetworkBuild?: boolean;
     temporalSplitting?: boolean;
     displayTextElements?: SortableNameReference[];
     linkDisplayTextElements?: SortableNameReference[];
     requiresMultipleContributors?: boolean;
-    defaultMapIcon?: Icon;
     publishCode?: PublishCode;
-    defaultRegularIcon?: Icon;
-    compounds?: Compound[];
+    defaultMapIcon?: Icon;
 }
 
 export interface Error {
@@ -2811,8 +2811,8 @@ export interface FieldMaskingConfigDTO {
 export interface Icon {
     id?: number;
     type?: IconType;
-    imageLocation?: string;
     imageType?: IconImageType;
+    imageLocation?: string;
 }
 
 export interface LinkBulkOperationResult {
@@ -2846,19 +2846,12 @@ export interface ReferenceListSummary {
 export interface Relationship extends DataObject {
     type?: RelationshipType;
     required?: boolean;
-    width?: number;
     qualifiedName?: string;
     managed?: boolean;
-    color?: string;
-    fromObjectLabel?: string;
-    toObjectLabel?: string;
-    toObjectTypeNames?: string[];
+    width?: number;
     fromObjectName?: string;
     toObjectName?: string;
-    summaryFields?: SortableNameReference[];
-    heterogeneousLink?: boolean;
-    linkFields?: { [index: string]: string }[];
-    joinTableName?: string;
+    color?: string;
     cardinality?: RelationshipCardinality;
     previousCardinality?: RelationshipCardinality;
     symmetric?: boolean;
@@ -2866,6 +2859,13 @@ export interface Relationship extends DataObject {
     reverseLabel?: string;
     dashType?: string;
     styles?: LinkStyleDTO[];
+    fromObjectLabel?: string;
+    toObjectLabel?: string;
+    toObjectTypeNames?: string[];
+    summaryFields?: SortableNameReference[];
+    heterogeneousLink?: boolean;
+    linkFields?: { [index: string]: string }[];
+    joinTableName?: string;
 }
 
 export interface SheetCopySelection {
@@ -2889,35 +2889,35 @@ export interface StoredDataObject extends DataObject {
     scale?: number;
     parentName?: string;
     nodeDecoration?: NodeDecorationDTO;
+    defaultRegularIcon?: Icon;
     nodeColor?: string;
     nodeShape?: string;
     markerColor?: string;
-    relationshipsTo?: Relationship[];
-    fileCategories?: FileCategory[];
     borderColor?: string;
     borderWidth?: number;
-    defaultMapIcon?: Icon;
+    relationshipsTo?: Relationship[];
+    fileCategories?: FileCategory[];
     attachmentsIndexedForSearch?: boolean;
     enableCasDistributedDataLoad?: boolean;
     elementGroupRoot?: boolean;
     requireSearchBeforeCreate?: boolean;
     mobileOfflineEnabled?: boolean;
-    defaultRegularIcon?: Icon;
-    relationshipsFrom?: Relationship[];
     styles?: EntityStyleDTO[];
+    defaultMapIcon?: Icon;
+    relationshipsFrom?: Relationship[];
 }
 
 export interface Transaction extends DataObject {
     fromObjectName?: string;
     toObjectName?: string;
-    lineWidthFunctionType?: AggregateFunctionType;
-    lineColorFieldName?: string;
-    lineColorFunctionType?: AggregateFunctionType;
+    toObjectTypeFieldName?: string;
     fromObjectTypeFieldName?: string;
     fromObjectRefFieldName?: string;
     toObjectRefFieldName?: string;
     lineWidthFieldName?: string;
-    toObjectTypeFieldName?: string;
+    lineWidthFunctionType?: AggregateFunctionType;
+    lineColorFieldName?: string;
+    lineColorFunctionType?: AggregateFunctionType;
 }
 
 export interface Version extends VersionSummary {
@@ -3256,12 +3256,12 @@ export interface EventMetadata {
 
 export interface ValidatableContextMapping extends SolutionAssignedDTO {
     tag?: string;
-    templateId?: any;
+    docType?: string;
+    uuid?: string;
     toolbarEnabled?: boolean;
     evaluateOrder?: number;
     fallbackToEvent?: string;
-    uuid?: string;
-    docType?: string;
+    templateId?: any;
     event?: string;
 }
 
@@ -3818,17 +3818,17 @@ export interface JavaType extends ResolvedType, Serializable, Type {
     genericSignature?: string;
     superClass?: JavaType;
     keyType?: JavaType;
-    typeHandler?: any;
-    recordType?: boolean;
+    javaLangObject?: boolean;
     valueHandler?: any;
+    typeHandler?: any;
     referencedType?: JavaType;
-    javaLangObject?: boolean;
+    recordType?: boolean;
+    enumImplType?: boolean;
     contentValueHandler?: any;
     contentTypeHandler?: any;
     erasedSignature?: string;
-    enumImplType?: boolean;
-    bindings?: TypeBindings;
     contentType?: JavaType;
+    bindings?: TypeBindings;
 }
 
 export interface Class<T> extends Serializable, GenericDeclaration, Type, AnnotatedElement, OfField<Class<any>>, Constable {
@@ -3845,12 +3845,12 @@ export interface ValueInstantiator {
 
 export interface JsonDeserializer<T> extends NullValueProvider {
     cachable?: boolean;
-    delegatee?: JsonDeserializer<any>;
-    knownPropertyNames?: any[];
-    objectIdReader?: ObjectIdReader;
     emptyValue?: any;
     nullValue?: T;
     emptyAccessPattern?: AccessPattern;
+    delegatee?: JsonDeserializer<any>;
+    knownPropertyNames?: any[];
+    objectIdReader?: ObjectIdReader;
 }
 
 export interface ObjectIdReader extends Serializable {
@@ -4058,13 +4058,13 @@ export interface ResolvedType {
     rawClass?: Class<any>;
     keyType?: ResolvedType;
     containerType?: boolean;
-    mapLikeType?: boolean;
-    collectionLikeType?: boolean;
-    arrayType?: boolean;
     throwable?: boolean;
     enumType?: boolean;
     concrete?: boolean;
+    collectionLikeType?: boolean;
+    arrayType?: boolean;
     referencedType?: ResolvedType;
+    mapLikeType?: boolean;
     parameterSource?: Class<any>;
     contentType?: ResolvedType;
 }
@@ -4104,6 +4104,7 @@ export interface ObjectIdResolver {
 
 export interface SettableBeanProperty extends ConcreteBeanPropertyBase, Serializable {
     objectIdInfo?: ObjectIdInfo;
+    valueDeserializer?: JsonDeserializer<any>;
     managedReferenceName?: string;
     valueTypeDeserializer?: TypeDeserializer;
     nullValueProvider?: NullValueProvider;
@@ -4111,7 +4112,6 @@ export interface SettableBeanProperty extends ConcreteBeanPropertyBase, Serializ
     creatorIndex?: number;
     injectableValueId?: any;
     injectionOnly?: boolean;
-    valueDeserializer?: JsonDeserializer<any>;
     ignorable?: boolean;
 }
 
@@ -4243,9 +4243,6 @@ export interface OfField<F> extends TypeDescriptor {
     primitive?: boolean;
 }
 
-export interface AnnotationMap extends Annotations {
-}
-
 export interface Member {
     modifiers?: number;
     name?: string;
@@ -4253,14 +4250,17 @@ export interface Member {
     declaringClass?: Class<any>;
 }
 
+export interface AnnotationMap extends Annotations {
+}
+
 export interface TypeResolutionContext {
 }
 
 export interface AnnotatedMember extends Annotated, Serializable {
     declaringClass?: Class<any>;
     fullName?: string;
-    allAnnotations?: AnnotationMap;
     member?: Member;
+    allAnnotations?: AnnotationMap;
     typeContext?: TypeResolutionContext;
 }
 
@@ -4268,8 +4268,8 @@ export interface ObjectIdInfo {
     generatorType?: Class<ObjectIdGenerator<any>>;
     resolverType?: Class<ObjectIdResolver>;
     alwaysAsId?: boolean;
-    propertyName?: PropertyName;
     scope?: Class<any>;
+    propertyName?: PropertyName;
 }
 
 export interface TypeDeserializer {
@@ -4283,9 +4283,9 @@ export interface PropertyMetadata extends Serializable {
     defaultValue?: string;
     index?: number;
     required?: boolean;
-    mergeInfo?: MergeInfo;
-    valueNulls?: Nulls;
     contentNulls?: Nulls;
+    valueNulls?: Nulls;
+    mergeInfo?: MergeInfo;
     description?: string;
 }
 

package/svi-datahub/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@types/svi-datahub",
-  "version": "17.26.32",
+  "version": "17.26.30",
   "types": "index.d.ts"
 }

package/tab/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/tab/tab-api.d.ts

@@ -1,7 +1,11 @@
 import { PageModeEvent } from "../control/page";
 /**
  * This API provides the functionality related to tabs.
- * Accessed from the window at window.sas.vi.tab.
+ *
+ * Accessed from the window at `window.sas.vi.tab`.
+ *
+ * @example window.sas.vi.tab.openTab("objectName", "objectId");
+ * @category API
  */
 export interface TabApi {
     /**

package/theme/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/theme/theme-api.d.ts

@@ -5,7 +5,11 @@ export declare enum Theme {
 }
 /**
  * This API provides the functionality related to SAS Visual Investigator's application theme.
- * Accessed from the window at window.sas.vi.theme.
+ *
+ * Accessed from the window at `window.sas.vi.theme`.
+ *
+ * @example window.sas.vi.theme.getCurrent();
+ * @category API
  */
 export interface ThemeApi {
     /**
@@ -17,7 +21,7 @@ export interface ThemeApi {
     /**
      * @method
      * @description Callback function when the theme is changed.
-     * @param {ThemeApi~themeChangeHandler} Function to be called when a theme is changed.
+     * @param {ThemeApi~themeChangeHandler} callback to be called when a theme is changed.
      * @returns {ThemeApi~stopThemeChangeHandler} A function that, when invoked, stops the callback from being called.
      */
     onChange(callback: (themeName: Theme) => void): () => void;

package/traversal/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/traversal/traversal-api.d.ts

@@ -7,7 +7,11 @@ export interface SviRecord extends Record {
 }
 /**
  * This API provides functionality related to traversal data.
- * Accessed from the window at window.sas.vi.traversal.
+ *
+ * Accessed from the window at `window.sas.vi.traversal`.
+ *
+ * @example window.sas.vi.traversal.getTraversals();
+ * @category API
  */
 export interface TraversalApi {
     /**

package/component/public-api.d.ts

@@ -1 +0,0 @@
-export * from "./index";

package/component/public-api.js

@@ -1 +0,0 @@
-export * from "./index";

package/http/public-api.d.ts

@@ -1 +0,0 @@
-export * from "./index";

package/http/public-api.js

@@ -1 +0,0 @@
-export * from "./index";

package/init/public-api.d.ts

@@ -1 +0,0 @@
-export * from "./index";

package/init/public-api.js

@@ -1 +0,0 @@
-export * from "./index";

package/public-api.d.ts

@@ -1 +0,0 @@
-export { SviClientApi, SviAdminApi, SviWindow, SviApi } from "./index";